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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass ListUserPoolsRequest data as a hash:

{
  next_token: "PaginationKeyType",
  max_results: 1, # required
}

Represents the request to list user pools.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

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

Returns:

  • (Integer)


6603
6604
6605
6606
6607
6608
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6603

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

#next_tokenString

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)


6603
6604
6605
6606
6607
6608
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6603

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