CognitoIdentityProvider / Paginator / ListUserPoolClients

ListUserPoolClients

class CognitoIdentityProvider.Paginator.ListUserPoolClients

paginator = client.get_paginator('list_user_pool_clients')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CognitoIdentityProvider.Client.list_user_pool_clients().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    UserPoolId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• UserPoolId (string) –

  [REQUIRED]

  The user pool ID for the user pool where you want to list user pool clients.

• 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

{
    'UserPoolClients': [
        {
            'ClientId': 'string',
            'UserPoolId': 'string',
            'ClientName': 'string'
        },
    ],

}

Response Structure

• (dict) –

  Represents the response from the server that lists user pool clients.

  • UserPoolClients (list) –

    The user pool clients in the response that lists user pool clients.

    • (dict) –

      The description of the user pool client.

      • ClientId (string) –

        The ID of the client associated with the user pool.

      • UserPoolId (string) –

        The user pool ID for the user pool where you want to describe the user pool client.

      • ClientName (string) –

        The client name from the user pool client description.