Connect / Client / describe_instance_storage_config

describe_instance_storage_config#

Connect.Client.describe_instance_storage_config(**kwargs)#

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

Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

See also: AWS API Documentation

Request Syntax

response = client.describe_instance_storage_config(
    InstanceId='string',
    AssociationId='string',
    ResourceType='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'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • AssociationId (string) –

    [REQUIRED]

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

  • ResourceType (string) –

    [REQUIRED]

    A valid resource type.

Return type:

dict

Returns:

Response Syntax

{
    'StorageConfig': {
        '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': 123,
            'EncryptionConfig': {
                'EncryptionType': 'KMS',
                'KeyId': 'string'
            }
        },
        'KinesisStreamConfig': {
            'StreamArn': 'string'
        },
        'KinesisFirehoseConfig': {
            'FirehoseArn': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • StorageConfig (dict) –

      A valid storage type.

      • 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 (dict) –

        The S3 bucket configuration.

        • BucketName (string) –

          The S3 bucket name.

        • BucketPrefix (string) –

          The S3 bucket prefix.

        • EncryptionConfig (dict) –

          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.

      • KinesisVideoStreamConfig (dict) –

        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 (dict) –

          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.

      • KinesisStreamConfig (dict) –

        The configuration of the Kinesis data stream.

        • StreamArn (string) –

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

      • KinesisFirehoseConfig (dict) –

        The configuration of the Kinesis Firehose delivery stream.

        • FirehoseArn (string) –

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

Exceptions