Connect / Client / list_analytics_data_associations

list_analytics_data_associations#

Connect.Client.list_analytics_data_associations(**kwargs)#

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

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

See also: AWS API Documentation

Request Syntax

response = client.list_analytics_data_associations(
    InstanceId='string',
    DataSetId='string',
    NextToken='string',
    MaxResults=123
)
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) – The identifier of the dataset to get the association status.

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

  • MaxResults (integer) – The maximum number of results to return per page.

Return type:

dict

Returns:

Response Syntax

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

    • NextToken (string) –

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

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException