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

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.

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)


3847
3848
3849
3850
3851
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3847

class ListUserPoolsRequest < Struct.new(
  :next_token,
  :max_results)
  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)


3847
3848
3849
3850
3851
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3847

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