Connect / Client / batch_disassociate_analytics_data_set

batch_disassociate_analytics_data_set#

Connect.Client.batch_disassociate_analytics_data_set(**kwargs)#

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

Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.

See also: AWS API Documentation

Request Syntax

response = client.batch_disassociate_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 associated dataset identifiers to remove.

    • (string) –

  • TargetAccountId (string) – The identifier of the target account. Use to disassociate a dataset from 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

{
    'Deleted': [
        'string',
    ],
    'Errors': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Deleted (list) –

      An array of successfully disassociated dataset identifiers.

      • (string) –

    • Errors (list) –

      A list of errors for any datasets not successfully removed.

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