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

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

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 ListGroupsRequest data as a hash:

{
  user_pool_id: "UserPoolIdType", # required
  limit: 1,
  next_token: "PaginationKey",
}

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

The limit of the request to list groups.

Returns:

  • (Integer)


3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3596

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


3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3596

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

#user_pool_idString

The user pool ID for the user pool.

Returns:

  • (String)


3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3596

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