AWS API Changes

2023/06/16 - Amazon Connect Service - 7 updated api methods

Changes Updates the *InstanceStorageConfig APIs to support a new ResourceType: SCREEN_RECORDINGS to enable screen recording and specify the storage configurations for publishing the recordings. Also updates DescribeInstance and ListInstances APIs to include InstanceAccessUrl attribute in the API response.

AssociateInstanceStorageConfig (updated)

Link ¶
Changes (request)

{'ResourceType': {'SCREEN_RECORDINGS'}}

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'|'ATTACHMENTS'|'CONTACT_EVALUATIONS'|'SCREEN_RECORDINGS',
    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 instance ID in the Amazon Resource Name (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.
    
    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 (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.
    
    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 (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.

DescribeInstance (updated)

Link ¶
Changes (response)

{'Instance': {'InstanceAccessUrl': 'string'}}

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

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

See also: AWS API Documentation

Request Syntax

client.describe_instance(
    InstanceId='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'Instance': {
        'Id': 'string',
        'Arn': 'string',
        'IdentityManagementType': 'SAML'|'CONNECT_MANAGED'|'EXISTING_DIRECTORY',
        'InstanceAlias': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'ServiceRole': 'string',
        'InstanceStatus': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED',
        'StatusReason': {
            'Message': 'string'
        },
        'InboundCallsEnabled': True|False,
        'OutboundCallsEnabled': True|False,
        'InstanceAccessUrl': 'string'
    }
}

Response Structure

(dict) --
- Instance (dict) --
  
  The name of the 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.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the instance.
  - IdentityManagementType (string) --
    
    The identity management type.
  - InstanceAlias (string) --
    
    The alias of instance.
  - CreatedTime (datetime) --
    
    When the instance was created.
  - ServiceRole (string) --
    
    The service role of the instance.
  - InstanceStatus (string) --
    
    The state of the instance.
  - StatusReason (dict) --
    
    Relevant details why the instance was not successfully created.
    - Message (string) --
      
      The message.
  - InboundCallsEnabled (boolean) --
    
    Whether inbound calls are enabled.
  - OutboundCallsEnabled (boolean) --
    
    Whether outbound calls are enabled.
  - InstanceAccessUrl (string) --
    
    This URL allows contact center users to access Amazon Connect admin website.

DescribeInstanceStorageConfig (updated)

Link ¶
Changes (request)

{'ResourceType': {'SCREEN_RECORDINGS'}}

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'|'ATTACHMENTS'|'CONTACT_EVALUATIONS'|'SCREEN_RECORDINGS'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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.
        
        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 (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 https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-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.

DisassociateInstanceStorageConfig (updated)

Link ¶
Changes (request)

{'ResourceType': {'SCREEN_RECORDINGS'}}

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'|'ATTACHMENTS'|'CONTACT_EVALUATIONS'|'SCREEN_RECORDINGS'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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': {'SCREEN_RECORDINGS'}}

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'|'ATTACHMENTS'|'CONTACT_EVALUATIONS'|'SCREEN_RECORDINGS',
    NextToken='string',
    MaxResults=123
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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.
        
        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 (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 https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-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.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

ListInstances (updated)

Link ¶
Changes (response)

{'InstanceSummaryList': {'InstanceAccessUrl': 'string'}}

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

Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

See also: AWS API Documentation

Request Syntax

client.list_instances(
    NextToken='string',
    MaxResults=123
)

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

{
    'InstanceSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'IdentityManagementType': 'SAML'|'CONNECT_MANAGED'|'EXISTING_DIRECTORY',
            'InstanceAlias': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'ServiceRole': 'string',
            'InstanceStatus': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED',
            'InboundCallsEnabled': True|False,
            'OutboundCallsEnabled': True|False,
            'InstanceAccessUrl': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- InstanceSummaryList (list) --
  
  Information about the instances.
  - (dict) --
    
    Information about the instance.
    - Id (string) --
      
      The identifier of the instance.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the instance.
    - IdentityManagementType (string) --
      
      The identity management type of the instance.
    - InstanceAlias (string) --
      
      The alias of the instance.
    - CreatedTime (datetime) --
      
      When the instance was created.
    - ServiceRole (string) --
      
      The service role of the instance.
    - InstanceStatus (string) --
      
      The state of the instance.
    - InboundCallsEnabled (boolean) --
      
      Whether inbound calls are enabled.
    - OutboundCallsEnabled (boolean) --
      
      Whether outbound calls are enabled.
    - InstanceAccessUrl (string) --
      
      This URL allows contact center users to access Amazon Connect admin website.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

UpdateInstanceStorageConfig (updated)

Link ¶
Changes (request)

{'ResourceType': {'SCREEN_RECORDINGS'}}

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'|'ATTACHMENTS'|'CONTACT_EVALUATIONS'|'SCREEN_RECORDINGS',
    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 instance ID in the Amazon Resource Name (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.
    
    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 (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.
    
    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 (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