You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::ListUserPoolClientsRequest

Inherits:

Struct

show all

Overview

Note:

When passing ListUserPoolClientsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  user_pool_id: "UserPoolIdType", # required
  max_results: 1,
  next_token: "PaginationKey",
}

Represents the request to list the user pool clients.

#max_results ⇒ Integer
The maximum number of results you want the request to return when listing the user pool clients.
#next_token ⇒ 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.
#user_pool_id ⇒ String
The user pool ID for the user pool where you want to list user pool clients.

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

Returns:

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

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.

Returns:

(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.

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

Returns:

(String) —
The user pool ID for the user pool where you want to list user pool clients.