[ aws . connect ]

update-instance-storage-config

Description

This API is in preview release for Amazon Connect and is subject to change.

Updates an existing configuration for a resource type. This API is idempotent.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-instance-storage-config
--instance-id <value>
--association-id <value>
--resource-type <value>
--storage-config <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

The identifier of the Amazon Connect instance.

--association-id (string)

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

--resource-type (string)

A valid resource type.

Possible values:

• CHAT_TRANSCRIPTS

• CALL_RECORDINGS

• SCHEDULED_REPORTS

• MEDIA_STREAMS

• CONTACT_TRACE_RECORDS

• AGENT_EVENTS

--storage-config (structure)

The storage configuration for the instance.

AssociationId -> (string)

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

StorageType -> (string)

A valid storage type.

S3Config -> (structure)

The S3 bucket configuration.

BucketName -> (string)

The S3 bucket name.

BucketPrefix -> (string)

The S3 bucket prefix.

EncryptionConfig -> (structure)

The Amazon S3 encryption configuration.

EncryptionType -> (string)

The type of encryption.

KeyId -> (string)

The identifier of the encryption key.

KinesisVideoStreamConfig -> (structure)

The configuration of the Kinesis video stream.

Prefix -> (string)

The prefix of the video stream.

RetentionPeriodHours -> (integer)

The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

EncryptionConfig -> (structure)

The encryption configuration.

EncryptionType -> (string)

The type of encryption.

KeyId -> (string)

The identifier of the encryption key.

KinesisStreamConfig -> (structure)

The configuration of the Kinesis data stream.

StreamArn -> (string)

The Amazon Resource Name (ARN) of the data stream.

KinesisFirehoseConfig -> (structure)

The configuration of the Kinesis Firehose delivery stream.

FirehoseArn -> (string)

The Amazon Resource Name (ARN) of the delivery stream.

Shorthand Syntax:

AssociationId=string,StorageType=string,S3Config={BucketName=string,BucketPrefix=string,EncryptionConfig={EncryptionType=string,KeyId=string}},KinesisVideoStreamConfig={Prefix=string,RetentionPeriodHours=integer,EncryptionConfig={EncryptionType=string,KeyId=string}},KinesisStreamConfig={StreamArn=string},KinesisFirehoseConfig={FirehoseArn=string}

JSON Syntax:

{
  "AssociationId": "string",
  "StorageType": "S3"|"KINESIS_VIDEO_STREAM"|"KINESIS_STREAM"|"KINESIS_FIREHOSE",
  "S3Config": {
    "BucketName": "string",
    "BucketPrefix": "string",
    "EncryptionConfig": {
      "EncryptionType": "KMS",
      "KeyId": "string"
    }
  },
  "KinesisVideoStreamConfig": {
    "Prefix": "string",
    "RetentionPeriodHours": integer,
    "EncryptionConfig": {
      "EncryptionType": "KMS",
      "KeyId": "string"
    }
  },
  "KinesisStreamConfig": {
    "StreamArn": "string"
  },
  "KinesisFirehoseConfig": {
    "FirehoseArn": "string"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

None