Class: Aws::CognitoIdentityProvider::Types::ListGroupsRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#limit ⇒ Integer

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

Returns:

  • (Integer) 


8465
8466
8467
8468
8469
8470
8471
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8465

class ListGroupsRequest < Struct.new(
  :user_pool_id,
  :limit,
  :next_token)
  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) 


8465
8466
8467
8468
8469
8470
8471
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8465

class ListGroupsRequest < Struct.new(
  :user_pool_id,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_id ⇒ String

The ID of the user pool where you want to list user groups.

Returns:

  • (String) 


8465
8466
8467
8468
8469
8470
8471
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8465

class ListGroupsRequest < Struct.new(
  :user_pool_id,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end