Amazon Connect Service

2025/02/14 - Amazon Connect Service - 1 new17 updated api methods

Changes  Release Notes: 1) Analytics API enhancements: Added new ListAnalyticsDataLakeDataSets API. 2) Onboarding API Idempotency: Adds ClientToken to instance creation and management APIs to support idempotency.

ListAnalyticsDataLakeDataSets (new) Link ¶

Lists the data lake datasets available to associate with for a given Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.list_analytics_data_lake_data_sets(
    InstanceId='string',
    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 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

{
    'Results': [
        {
            'DataSetId': 'string',
            'DataSetName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Results (list) --

      An array of successful results: DataSetId, DataSetName. This is a paginated API, so nextToken is given if there are more results to be returned.

      • (dict) --

        Information about datasets that are available to associate with: DataSetId, DataSetName.

        • DataSetId (string) --

          The identifier of the dataset.

        • DataSetName (string) --

          The name of the dataset.

    • NextToken (string) --

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

AssociateApprovedOrigin (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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

Associates an approved origin to an Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.associate_approved_origin(
    InstanceId='string',
    Origin='string',
    ClientToken='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 Origin:

string

param Origin:

[REQUIRED]

The domain to add to your allow list.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

returns:

None

AssociateBot (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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

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

See also: AWS API Documentation

Request Syntax

client.associate_bot(
    InstanceId='string',
    LexBot={
        'Name': 'string',
        'LexRegion': 'string'
    },
    LexV2Bot={
        'AliasArn': 'string'
    },
    ClientToken='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 LexBot:

dict

param LexBot:

Configuration information of an Amazon Lex bot.

  • Name (string) -- [REQUIRED]

    The name of the Amazon Lex bot.

  • LexRegion (string) -- [REQUIRED]

    The Amazon Web Services Region where the Amazon Lex bot was created.

type LexV2Bot:

dict

param LexV2Bot:

The Amazon Lex V2 bot to associate with the instance.

  • AliasArn (string) --

    The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

returns:

None

AssociateInstanceStorageConfig (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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'|'REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS'|'REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS'|'EMAIL_MESSAGES',
    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'
        }
    },
    ClientToken='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. To enable streaming for real-time analysis of contacts, use the following types:

  • For chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS.

  • For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.

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.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

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.

AssociateLambdaFunction (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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

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',
    ClientToken='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 FunctionArn:

string

param FunctionArn:

[REQUIRED]

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

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

returns:

None

AssociateLexBot (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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

Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.

See also: AWS API Documentation

Request Syntax

client.associate_lex_bot(
    InstanceId='string',
    LexBot={
        'Name': 'string',
        'LexRegion': 'string'
    },
    ClientToken='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 LexBot:

dict

param LexBot:

[REQUIRED]

The Amazon Lex bot to associate with the instance.

  • Name (string) -- [REQUIRED]

    The name of the Amazon Lex bot.

  • LexRegion (string) -- [REQUIRED]

    The Amazon Web Services Region where the Amazon Lex bot was created.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

returns:

None

AssociateSecurityKey (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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

Associates a security key to the instance.

See also: AWS API Documentation

Request Syntax

client.associate_security_key(
    InstanceId='string',
    Key='string',
    ClientToken='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 Key:

string

param Key:

[REQUIRED]

A valid security key in PEM format as a String.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

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.

BatchAssociateAnalyticsDataSet (updated) Link ¶
Changes (response) 
{'Created': {'ResourceShareStatus': 'string'}}

Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.

See also: AWS API Documentation

Request Syntax

client.batch_associate_analytics_data_set(
    InstanceId='string',
    DataSetIds=[
        'string',
    ],
    TargetAccountId='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 DataSetIds:

list

param DataSetIds:

[REQUIRED]

An array of dataset identifiers to associate.

  • (string) --

type TargetAccountId:

string

param TargetAccountId:

The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

rtype:

dict

returns:

Response Syntax

{
    'Created': [
        {
            'DataSetId': 'string',
            'TargetAccountId': 'string',
            'ResourceShareId': 'string',
            'ResourceShareArn': 'string',
            'ResourceShareStatus': 'string'
        },
    ],
    'Errors': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Created (list) --

      Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn.

      • (dict) --

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

        Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn.

        • DataSetId (string) --

          The identifier of the dataset.

        • TargetAccountId (string) --

          The identifier of the target account.

        • ResourceShareId (string) --

          The Resource Access Manager share ID.

        • ResourceShareArn (string) --

          The Amazon Resource Name (ARN) of the Resource Access Manager share.

        • ResourceShareStatus (string) --

          The Amazon Web Services Resource Access Manager status of association.

    • Errors (list) --

      A list of errors for datasets that aren't successfully associated with the target account.

      • (dict) --

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

        List of errors for dataset association failures.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The corresponding error message for the error code.

DeleteInstance (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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

Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

See also: AWS API Documentation

Request Syntax

client.delete_instance(
    InstanceId='string',
    ClientToken='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 ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

returns:

None

DisassociateApprovedOrigin (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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

Revokes access to integrated applications from Amazon Connect.

See also: AWS API Documentation

Request Syntax

client.disassociate_approved_origin(
    InstanceId='string',
    Origin='string',
    ClientToken='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 Origin:

string

param Origin:

[REQUIRED]

The domain URL of the integrated application.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

returns:

None

DisassociateBot (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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

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

See also: AWS API Documentation

Request Syntax

client.disassociate_bot(
    InstanceId='string',
    LexBot={
        'Name': 'string',
        'LexRegion': 'string'
    },
    LexV2Bot={
        'AliasArn': 'string'
    },
    ClientToken='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 LexBot:

dict

param LexBot:

Configuration information of an Amazon Lex bot.

  • Name (string) -- [REQUIRED]

    The name of the Amazon Lex bot.

  • LexRegion (string) -- [REQUIRED]

    The Amazon Web Services Region where the Amazon Lex bot was created.

type LexV2Bot:

dict

param LexV2Bot:

The Amazon Lex V2 bot to disassociate from the instance.

  • AliasArn (string) --

    The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

returns:

None

DisassociateInstanceStorageConfig (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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'|'REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS'|'REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS'|'EMAIL_MESSAGES',
    ClientToken='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 ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

returns:

None

DisassociateLambdaFunction (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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

Remove the Lambda function from the dropdown options available in the relevant flow blocks.

See also: AWS API Documentation

Request Syntax

client.disassociate_lambda_function(
    InstanceId='string',
    FunctionArn='string',
    ClientToken='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 FunctionArn:

string

param FunctionArn:

[REQUIRED]

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

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

returns:

None

DisassociateLexBot (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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

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',
    ClientToken='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 BotName:

string

param BotName:

[REQUIRED]

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

type LexRegion:

string

param LexRegion:

[REQUIRED]

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

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

returns:

None

DisassociateSecurityKey (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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

Deletes the specified security key.

See also: AWS API Documentation

Request Syntax

client.disassociate_security_key(
    InstanceId='string',
    AssociationId='string',
    ClientToken='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 ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

returns:

None

ListAnalyticsDataAssociations (updated) Link ¶
Changes (response) 
{'Results': {'ResourceShareStatus': 'string'}}

Lists the association status of requested dataset ID for a given Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.list_analytics_data_associations(
    InstanceId='string',
    DataSetId='string',
    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 DataSetId:

string

param DataSetId:

The identifier of the dataset to get the association status.

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

{
    'Results': [
        {
            'DataSetId': 'string',
            'TargetAccountId': 'string',
            'ResourceShareId': 'string',
            'ResourceShareArn': 'string',
            'ResourceShareStatus': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Results (list) --

      An array of successful results: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn. This is a paginated API, so nextToken is given if there are more results to be returned.

      • (dict) --

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

        Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn.

        • DataSetId (string) --

          The identifier of the dataset.

        • TargetAccountId (string) --

          The identifier of the target account.

        • ResourceShareId (string) --

          The Resource Access Manager share ID.

        • ResourceShareArn (string) --

          The Amazon Resource Name (ARN) of the Resource Access Manager share.

        • ResourceShareStatus (string) --

          The Amazon Web Services Resource Access Manager status of association.

    • NextToken (string) --

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

UpdateInstanceAttribute (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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

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'|'MULTI_PARTY_CONFERENCE'|'HIGH_VOLUME_OUTBOUND'|'ENHANCED_CONTACT_MONITORING'|'ENHANCED_CHAT_MONITORING'|'MULTI_PARTY_CHAT_CONFERENCE',
    Value='string',
    ClientToken='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 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.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

returns:

None

UpdateInstanceStorageConfig (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

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'|'REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS'|'REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS'|'EMAIL_MESSAGES',
    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'
        }
    },
    ClientToken='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.

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

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

returns:

None