Class: Aws::CognitoIdentityProvider::Types::ListUsersInGroupRequest

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

#group_name ⇒ String

The name of the group that you want to query for user membership.

Returns:

  • (String) 


8421
8422
8423
8424
8425
8426
8427
8428
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8421

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

#limit ⇒ Integer

The maximum number of groups that you want Amazon Cognito to return in the response. In some SDK contexts, this operation might return fewer items than you specify in the Limit parameter without having reached the end of the full list. If the response contains a PaginationToken, then there are more results.

Returns:

  • (Integer) 


8421
8422
8423
8424
8425
8426
8427
8428
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8421

class ListUsersInGroupRequest < Struct.new(
  :user_pool_id,
  :group_name,
  :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) 


8421
8422
8423
8424
8425
8426
8427
8428
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8421

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

#user_pool_id ⇒ String

The ID of the user pool where you want to view the membership of the requested group.

Returns:

  • (String) 


8421
8422
8423
8424
8425
8426
8427
8428
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8421

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