CmdID

CmdID / aws / aws cognito-idp

aws cognito-idp list-user-pool-clients

Given a user pool ID, lists app clients. AWS CLI reference

1 example 3 options Its page in the AWS CLI reference

Opens CmdID with your command. It is read in your browser and sent nowhere.

Examples

from aws-cli, each command read by CmdID

To list app clients

The following list-user-pool-clients example lists the first three app clients in the requested user pool.

aws cognito-idp list-user-pool-clients --user-pool-id us-west-2_EXAMPLE --max-results 3Identify
--user-pool-idThe ID of the user pool where you want to list user pool clients.
--max-resultsThe maximum number of app clients that you want Amazon Cognito to return in the response.
Its output
{
    "NextToken": "[Pagination token]",
    "UserPoolClients": [
        {
            "ClientId": "1example23456789",
            "ClientName": "app-client-1",
            "UserPoolId": "us-west-2_EXAMPLE"
        },
        {
            "ClientId": "2example34567890",
            "ClientName": "app-client-2",
            "UserPoolId": "us-west-2_EXAMPLE"
        },
        {
            "ClientId": "3example45678901",
            "ClientName": "app-client-3",
            "UserPoolId": "us-west-2_EXAMPLE"
        }
    ]
}

For more information, see App clients in the Amazon Cognito Developer Guide.

Options

3 in the AWS CLI reference
--max-resultsThe maximum number of app clients that you want Amazon Cognito to return in the response.
--next-tokenThis API operation returns a limited number of results.
--user-pool-idThe ID of the user pool where you want to list user pool clients.