Connect / Client / list_traffic_distribution_group_users

list_traffic_distribution_group_users#

Connect.Client.list_traffic_distribution_group_users(**kwargs)#

Lists traffic distribution group users.

See also: AWS API Documentation

Request Syntax

response = client.list_traffic_distribution_group_users(
    TrafficDistributionGroupId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • TrafficDistributionGroupId (string) –

    [REQUIRED]

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'TrafficDistributionGroupUserSummaryList': [
        {
            'UserId': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

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

    • TrafficDistributionGroupUserSummaryList (list) –

      A list of traffic distribution group users.

      • (dict) –

        Summary information about a traffic distribution group user.

        • UserId (string) –

          The identifier for the user. This can be the ID or the ARN of the user.

Exceptions