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 limit of the request to list groups.

Returns:

  • (Integer) 


1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1227

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

#next_token ⇒ String

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) 


1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1227

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

#user_pool_id ⇒ String

The user pool ID for the user pool.

Returns:

  • (String) 


1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1227

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

#username ⇒ String

The username 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) 


1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1227

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