AWS API Changes

2020/11/20 - Amazon Connect Service - 24 new api methods

Changes This release adds a set of Amazon Connect APIs to programmatically control instance creation, modification, description and deletion.

ListInstanceStorageConfigs (new)

Link ¶

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

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect 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 maximimum 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 configuration.
      - BucketName (string) --
        
        The S3 bucket name.
      - BucketPrefix (string) --
        
        The S3 bucket prefix.
      - EncryptionConfig (dict) --
        
        The S3 encryption configuration.
        
        EncryptionType (string) --
        
        The type of encryption.
        
        KeyId (string) --
        
        The identifier 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 identifier 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.

DisassociateLambdaFunction (new)

Link ¶

Remove the Lambda function from the drop-down options available in the relevant contact flow blocks.

See also: AWS API Documentation

Request Syntax

client.disassociate_lambda_function(
    InstanceId='string',
    FunctionArn='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance..

type FunctionArn

string

param FunctionArn

[REQUIRED]

The Amazon Resource Name (ARN) of the Lambda function being disassociated.

returns

None

ListLexBots (new)

Link ¶

Returns a paginated list of all the Amazon Lex bots currently associated with the instance.

See also: AWS API Documentation

Request Syntax

client.list_lex_bots(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

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 maximimum number of results to return per page.

rtype

dict

returns

Response Syntax

{
    'LexBots': [
        {
            'Name': 'string',
            'LexRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- LexBots (list) --
  
  The the names and regions of the Amazon Lex bots associated with the specified instance.
  - (dict) --
    
    Configuration information of an Amazon Lex bot.
    - Name (string) --
      
      The name of the Amazon Lex bot.
    - LexRegion (string) --
      
      The Region the Amazon Lex bot was created in.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

AssociateLexBot (new)

Link ¶

Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.

See also: AWS API Documentation

Request Syntax

client.associate_lex_bot(
    InstanceId='string',
    LexBot={
        'Name': 'string',
        'LexRegion': 'string'
    }
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type LexBot

dict

param LexBot

[REQUIRED]

The Amazon Lex box to associate with the instance.

Name (string) --

The name of the Amazon Lex bot.
LexRegion (string) --

The Region the Amazon Lex bot was created in.

returns

None

AssociateApprovedOrigin (new)

Link ¶

Associates an approved origin to an Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.associate_approved_origin(
    InstanceId='string',
    Origin='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type Origin

string

param Origin

[REQUIRED]

The domain to add to your allow list.

returns

None

ListApprovedOrigins (new)

Link ¶

Returns a paginated list of all approved origins associated with the instance.

See also: AWS API Documentation

Request Syntax

client.list_approved_origins(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

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 maximimum number of results to return per page.

rtype

dict

returns

Response Syntax

{
    'Origins': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Origins (list) --
  
  The approved origins.
  - (string) --
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

ListLambdaFunctions (new)

Link ¶

Returns a paginated list of all the Lambda functions that show up in the drop-down options in the relevant contact flow blocks.

See also: AWS API Documentation

Request Syntax

client.list_lambda_functions(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

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 maximimum number of results to return per page.

rtype

dict

returns

Response Syntax

{
    'LambdaFunctions': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- LambdaFunctions (list) --
  
  The Lambdafunction ARNs associated with the specified instance.
  - (string) --
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

DisassociateApprovedOrigin (new)

Link ¶

Revokes access to integrated applications from Amazon Connect.

See also: AWS API Documentation

Request Syntax

client.disassociate_approved_origin(
    InstanceId='string',
    Origin='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type Origin

string

param Origin

[REQUIRED]

The domain URL of the integrated application.

returns

None

DescribeInstance (new)

Link ¶

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.

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
    }
}

Response Structure

(dict) --
- Instance (dict) --
  
  The name of the instance.
  - Id (string) --
    
    The identifier of the Amazon Connect 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.

DescribeInstanceAttribute (new)

Link ¶

Describes the specified instance attribute.

See also: AWS API Documentation

Request Syntax

client.describe_instance_attribute(
    InstanceId='string',
    AttributeType='INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type AttributeType

string

param AttributeType

[REQUIRED]

The type of attribute.

rtype

dict

returns

Response Syntax

{
    'Attribute': {
        'AttributeType': 'INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA',
        'Value': 'string'
    }
}

Response Structure

(dict) --
- Attribute (dict) --
  
  The type of attribute.
  - AttributeType (string) --
    
    The type of attribute.
  - Value (string) --
    
    The value of the attribute.

DeleteInstance (new)

Link ¶

Deletes the Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.delete_instance(
    InstanceId='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

returns

None

ListInstanceAttributes (new)

Link ¶

Returns a paginated list of all attribute types for the given instance.

See also: AWS API Documentation

Request Syntax

client.list_instance_attributes(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

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 maximimum number of results to return per page.

rtype

dict

returns

Response Syntax

{
    'Attributes': [
        {
            'AttributeType': 'INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Attributes (list) --
  
  The attribute types.
  - (dict) --
    
    A toggle for an individual feature at the instance level.
    - AttributeType (string) --
      
      The type of attribute.
    - Value (string) --
      
      The value of the attribute.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

UpdateInstanceAttribute (new)

Link ¶

Updates the value for the specified attribute type.

See also: AWS API Documentation

Request Syntax

client.update_instance_attribute(
    InstanceId='string',
    AttributeType='INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA',
    Value='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type AttributeType

string

param AttributeType

[REQUIRED]

The type of attribute.

type Value

string

param Value

[REQUIRED]

The value for the attribute. Maximum character limit is 100.

returns

None

UpdateInstanceStorageConfig (new)

Link ¶

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',
    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.

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 configuration.
- BucketName (string) -- [REQUIRED]
  
  The S3 bucket name.
- BucketPrefix (string) -- [REQUIRED]
  
  The S3 bucket prefix.
- EncryptionConfig (dict) --
  
  The S3 encryption configuration.
  - EncryptionType (string) -- [REQUIRED]
    
    The type of encryption.
  - KeyId (string) -- [REQUIRED]
    
    The identifier 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 identifier 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

AssociateLambdaFunction (new)

Link ¶

Allows the specified Amazon Connect instance to access the specified Lambda function.

See also: AWS API Documentation

Request Syntax

client.associate_lambda_function(
    InstanceId='string',
    FunctionArn='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type FunctionArn

string

param FunctionArn

[REQUIRED]

The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.

returns

None

AssociateSecurityKey (new)

Link ¶

Associates a security key to the instance.

See also: AWS API Documentation

Request Syntax

client.associate_security_key(
    InstanceId='string',
    Key='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type Key

string

param Key

[REQUIRED]

A valid security key in PEM format.

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.

ListSecurityKeys (new)

Link ¶

Returns a paginated list of all security keys associated with the instance.

See also: AWS API Documentation

Request Syntax

client.list_security_keys(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

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 maximimum number of results to return per page.

rtype

dict

returns

Response Syntax

{
    'SecurityKeys': [
        {
            'AssociationId': 'string',
            'Key': 'string',
            'CreationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- SecurityKeys (list) --
  
  The security keys.
  - (dict) --
    
    Configuration information of the security key.
    - AssociationId (string) --
      
      The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
    - Key (string) --
      
      The key of the security key.
    - CreationTime (datetime) --
      
      When the security key was created.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

DisassociateLexBot (new)

Link ¶

Revokes authorization from the specified instance to access the specified Amazon Lex bot.

See also: AWS API Documentation

Request Syntax

client.disassociate_lex_bot(
    InstanceId='string',
    BotName='string',
    LexRegion='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type BotName

string

param BotName

[REQUIRED]

The name of the Amazon Lex bot. Maximum character limit of 50.

type LexRegion

string

param LexRegion

[REQUIRED]

The Region in which the Amazon Lex bot has been created.

returns

None

ListInstances (new)

Link ¶

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 maximimum 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
        },
    ],
    '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.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

CreateInstance (new)

Link ¶

Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage (such as Amazon S3, or Kinesis) or allow for any configurations on features such as Contact Lens for Amazon Connect.

See also: AWS API Documentation

Request Syntax

client.create_instance(
    ClientToken='string',
    IdentityManagementType='SAML'|'CONNECT_MANAGED'|'EXISTING_DIRECTORY',
    InstanceAlias='string',
    DirectoryId='string',
    InboundCallsEnabled=True|False,
    OutboundCallsEnabled=True|False
)

type ClientToken

string

param ClientToken

The idempotency token.

type IdentityManagementType

string

param IdentityManagementType

[REQUIRED]

The type of identity management for your Amazon Connect users.

type InstanceAlias

string

param InstanceAlias

The name for your instance.

type DirectoryId

string

param DirectoryId

The identifier for the directory.

type InboundCallsEnabled

boolean

param InboundCallsEnabled

[REQUIRED]

Whether your contact center handles incoming contacts.

type OutboundCallsEnabled

boolean

param OutboundCallsEnabled

[REQUIRED]

Whether your contact center allows outbound calls.

rtype

dict

returns

Response Syntax

{
    'Id': 'string',
    'Arn': 'string'
}

Response Structure

(dict) --
- Id (string) --
  
  The identifier for the instance.
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the instance.

DisassociateInstanceStorageConfig (new)

Link ¶

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'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect 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

DescribeInstanceStorageConfig (new)

Link ¶

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'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect 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 configuration.
    - BucketName (string) --
      
      The S3 bucket name.
    - BucketPrefix (string) --
      
      The S3 bucket prefix.
    - EncryptionConfig (dict) --
      
      The S3 encryption configuration.
      - EncryptionType (string) --
        
        The type of encryption.
      - KeyId (string) --
        
        The identifier 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 identifier 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.

DisassociateSecurityKey (new)

Link ¶

Deletes the specified security key.

See also: AWS API Documentation

Request Syntax

client.disassociate_security_key(
    InstanceId='string',
    AssociationId='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect 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.

returns

None

AssociateInstanceStorageConfig (new)

Link ¶

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 Amazon 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',
    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.

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 configuration.
- BucketName (string) -- [REQUIRED]
  
  The S3 bucket name.
- BucketPrefix (string) -- [REQUIRED]
  
  The S3 bucket prefix.
- EncryptionConfig (dict) --
  
  The S3 encryption configuration.
  - EncryptionType (string) -- [REQUIRED]
    
    The type of encryption.
  - KeyId (string) -- [REQUIRED]
    
    The identifier 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 identifier 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.