Amazon Connect Service

2022/03/04 - Amazon Connect Service - 5 updated api methods

Changes  This release updates the *InstanceStorageConfig APIs so they support a new ResourceType: REAL_TIME_CONTACT_ANALYSIS_SEGMENTS. Use this resource type to enable streaming for real-time contact analysis and to associate the Kinesis stream where real-time contact analysis segments will be published.

AssociateInstanceStorageConfig (updated) Link ¶
Changes (request) 
{'ResourceType': {'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS'}}

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

Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.

This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.

See also: AWS API Documentation

Request Syntax

client.associate_instance_storage_config(
    InstanceId='string',
    ResourceType='CHAT_TRANSCRIPTS'|'CALL_RECORDINGS'|'SCHEDULED_REPORTS'|'MEDIA_STREAMS'|'CONTACT_TRACE_RECORDS'|'AGENT_EVENTS'|'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS',
    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'
        }
    }
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type ResourceType:

string

param ResourceType:

[REQUIRED]

A valid resource type.

type StorageConfig:

dict

param StorageConfig:

[REQUIRED]

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) -- [REQUIRED]

    A valid storage type.

  • S3Config (dict) --

    The S3 bucket configuration.

    • BucketName (string) -- [REQUIRED]

      The S3 bucket name.

    • BucketPrefix (string) -- [REQUIRED]

      The S3 bucket prefix.

    • EncryptionConfig (dict) --

      The Amazon S3 encryption configuration.

      • EncryptionType (string) -- [REQUIRED]

        The type of encryption.

      • KeyId (string) -- [REQUIRED]

        The full ARN of the encryption key.

  • KinesisVideoStreamConfig (dict) --

    The configuration of the Kinesis video stream.

    • Prefix (string) -- [REQUIRED]

      The prefix of the video stream.

    • RetentionPeriodHours (integer) -- [REQUIRED]

      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) -- [REQUIRED]

      The encryption configuration.

      • EncryptionType (string) -- [REQUIRED]

        The type of encryption.

      • KeyId (string) -- [REQUIRED]

        The full ARN of the encryption key.

  • KinesisStreamConfig (dict) --

    The configuration of the Kinesis data stream.

    • StreamArn (string) -- [REQUIRED]

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

  • KinesisFirehoseConfig (dict) --

    The configuration of the Kinesis Firehose delivery stream.

    • FirehoseArn (string) -- [REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'AssociationId': 'string'
}

Response Structure

  • (dict) --

    • AssociationId (string) --

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

DescribeInstanceStorageConfig (updated) Link ¶
Changes (request) 
{'ResourceType': {'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS'}}

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

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'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type AssociationId:

string

param AssociationId:

[REQUIRED]

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

type ResourceType:

string

param ResourceType:

[REQUIRED]

A valid resource type.

rtype:

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.

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

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

DisassociateInstanceStorageConfig (updated) Link ¶
Changes (request) 
{'ResourceType': {'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS'}}

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

Removes the storage type configurations for the specified resource type and association ID.

See also: AWS API Documentation

Request Syntax

client.disassociate_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'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type AssociationId:

string

param AssociationId:

[REQUIRED]

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

type ResourceType:

string

param ResourceType:

[REQUIRED]

A valid resource type.

returns:

None

ListInstanceStorageConfigs (updated) Link ¶
Changes (request) 
{'ResourceType': {'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS'}}

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

Returns a paginated list of storage configs for the identified instance and resource type.

See also: AWS API Documentation

Request Syntax

client.list_instance_storage_configs(
    InstanceId='string',
    ResourceType='CHAT_TRANSCRIPTS'|'CALL_RECORDINGS'|'SCHEDULED_REPORTS'|'MEDIA_STREAMS'|'CONTACT_TRACE_RECORDS'|'AGENT_EVENTS'|'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS',
    NextToken='string',
    MaxResults=123
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type ResourceType:

string

param ResourceType:

[REQUIRED]

A valid resource type.

type NextToken:

string

param NextToken:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

rtype:

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'
            }
        },
    ],
    'NextToken': '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.

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

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

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.

UpdateInstanceStorageConfig (updated) Link ¶
Changes (request) 
{'ResourceType': {'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS'}}

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

Request Syntax

client.update_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',
    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'
        }
    }
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type AssociationId:

string

param AssociationId:

[REQUIRED]

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

type ResourceType:

string

param ResourceType:

[REQUIRED]

A valid resource type.

type StorageConfig:

dict

param StorageConfig:

[REQUIRED]

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) -- [REQUIRED]

    A valid storage type.

  • S3Config (dict) --

    The S3 bucket configuration.

    • BucketName (string) -- [REQUIRED]

      The S3 bucket name.

    • BucketPrefix (string) -- [REQUIRED]

      The S3 bucket prefix.

    • EncryptionConfig (dict) --

      The Amazon S3 encryption configuration.

      • EncryptionType (string) -- [REQUIRED]

        The type of encryption.

      • KeyId (string) -- [REQUIRED]

        The full ARN of the encryption key.

  • KinesisVideoStreamConfig (dict) --

    The configuration of the Kinesis video stream.

    • Prefix (string) -- [REQUIRED]

      The prefix of the video stream.

    • RetentionPeriodHours (integer) -- [REQUIRED]

      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) -- [REQUIRED]

      The encryption configuration.

      • EncryptionType (string) -- [REQUIRED]

        The type of encryption.

      • KeyId (string) -- [REQUIRED]

        The full ARN of the encryption key.

  • KinesisStreamConfig (dict) --

    The configuration of the Kinesis data stream.

    • StreamArn (string) -- [REQUIRED]

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

  • KinesisFirehoseConfig (dict) --

    The configuration of the Kinesis Firehose delivery stream.

    • FirehoseArn (string) -- [REQUIRED]

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

returns:

None