Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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

Synopsis

  update-instance-storage-config
--instance-id <value>
--association-id <value>
--resource-type <value>
--storage-config <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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
  • REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
  • ATTACHMENTS
  • CONTACT_EVALUATIONS
  • SCREEN_RECORDINGS
  • REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS
  • REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS

--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 full ARN of the encryption key.

Note

Be sure to provide the full ARN of the encryption key, not just the ID.

Amazon Connect supports only KMS keys with the default key spec of ` SYMMETRIC_DEFAULT https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default`__ .

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 full ARN of the encryption key.

Note

Be sure to provide the full ARN of the encryption key, not just the ID.

Amazon Connect supports only KMS keys with the default key spec of ` SYMMETRIC_DEFAULT https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default`__ .

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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

None