Connect / Paginator / ListTrafficDistributionGroupUsers

ListTrafficDistributionGroupUsers

class Connect.Paginator.ListTrafficDistributionGroupUsers

paginator = client.get_paginator('list_traffic_distribution_group_users')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_traffic_distribution_group_users().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TrafficDistributionGroupId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

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