Connect / Client / associate_analytics_data_set

associate_analytics_data_set#

Connect.Client.associate_analytics_data_set(**kwargs)#

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

Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.

See also: AWS API Documentation

Request Syntax

response = client.associate_analytics_data_set(
    InstanceId='string',
    DataSetId='string',
    TargetAccountId='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

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

  • DataSetId (string) –

    [REQUIRED]

    The identifier of the dataset to associate with the target account.

  • TargetAccountId (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'DataSetId': 'string',
    'TargetAccountId': 'string',
    'ResourceShareId': 'string',
    'ResourceShareArn': 'string'
}

Response Structure

  • (dict) –

    • DataSetId (string) –

      The identifier of the dataset that was associated.

    • TargetAccountId (string) –

      The identifier of the target account.

    • ResourceShareId (string) –

      The Resource Access Manager share ID that is generated.

    • ResourceShareArn (string) –

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

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException