Class: Aws::CognitoIdentityProvider::Types::ListUserPoolsRequest

Inherits:

Struct

Object
Struct
Aws::CognitoIdentityProvider::Types::ListUserPoolsRequest

show all

Defined in:: gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Represents the request to list user pools.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#max_results ⇒ Integer
The maximum number of user pools that you want Amazon Cognito to return in the response.
#next_token ⇒ String
This API operation returns a limited number of results.

Instance Attribute Details

#max_results ⇒ `Integer`

The maximum number of user pools that you want Amazon Cognito to return in the response.

Returns:

(Integer)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8362

class ListUserPoolsRequest < Struct.new(
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ `String`

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.