Connect / Paginator / ListInstanceStorageConfigs

ListInstanceStorageConfigs

class Connect.Paginator.ListInstanceStorageConfigs

paginator = client.get_paginator('list_instance_storage_configs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_instance_storage_configs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='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'|'EMAIL_MESSAGES',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

• ResourceType (string) –

  [REQUIRED]

  A valid resource type.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'StorageConfigs': [
        {
            '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) –

  • StorageConfigs (list) –

    A valid storage type.

    • (dict) –

      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 (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.