Class: Aws::CognitoIdentityProvider::Types::AdminListGroupsForUserRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:username]

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) 


1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1464

class AdminListGroupsForUserRequest < Struct.new(
  :username,
  :user_pool_id,
  :limit,
  :next_token)
  SENSITIVE = [:username]
  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) 


1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1464

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

#user_pool_id ⇒ String

The ID of the user pool where you want to view a user's groups.

Returns:

  • (String) 


1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1464

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

#username ⇒ String

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Returns:

  • (String) 


1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1464

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