CognitoIdentityProvider / Client / list_user_pool_clients

list_user_pool_clients#

CognitoIdentityProvider.Client.list_user_pool_clients(**kwargs)#

Lists the clients that have been created for the specified user pool.

See also: AWS API Documentation

Request Syntax

response = client.list_user_pool_clients(
    UserPoolId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • UserPoolId (string) –

    [REQUIRED]

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

  • MaxResults (integer) – The maximum number of results you want the request to return when listing the user pool clients.

  • NextToken (string) – An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Return type:

dict

Returns:

Response Syntax

{
    'UserPoolClients': [
        {
            'ClientId': 'string',
            'UserPoolId': 'string',
            'ClientName': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Exceptions

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

  • CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException