Connect / Client / batch_associate_analytics_data_set

batch_associate_analytics_data_set#

Connect.Client.batch_associate_analytics_data_set(**kwargs)#

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

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

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

  • DataSetIds (list) –

    [REQUIRED]

    An array of dataset identifiers to associate.

    • (string) –

  • 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

{
    'Created': [
        {
            'DataSetId': 'string',
            'TargetAccountId': 'string',
            'ResourceShareId': 'string',
            'ResourceShareArn': '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.

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

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException