Connect / Paginator / ListUsers

ListUsers

class Connect.Paginator.ListUsers

paginator = client.get_paginator('list_users')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

• 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

{
    'UserSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Username': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • UserSummaryList (list) –

    Information about the users.

    • (dict) –

      Contains summary information about a user.

      • Id (string) –

        The identifier of the user account.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the user account.

      • Username (string) –

        The Amazon Connect user name of the user account.