List User Pool Clients

cognitoidentityprovider_list_user_pool_clients

R Documentation

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

Description

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

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_list_user_pool_clients(UserPoolId, MaxResults,
  NextToken)

Arguments

UserPoolId

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

MaxResults

The maximum number of results you want the request to return when listing the user pool clients.

NextToken

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.

Value

A list with the following syntax:

list(
  UserPoolClients = list(
    list(
      ClientId = "string",
      UserPoolId = "string",
      ClientName = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_user_pool_clients(
  UserPoolId = "string",
  MaxResults = 123,
  NextToken = "string"
)