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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Represents the request to list user pools.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8159

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.

Returns:

• (String)

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

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