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

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

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

Constant Summary collapse

SENSITIVE =
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

The limit of the request to list groups.

Returns:

  • (Integer)


1424
1425
1426
1427
1428
1429
1430
1431
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1424

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


1424
1425
1426
1427
1428
1429
1430
1431
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1424

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

#user_pool_idString

The user pool ID for the user pool.

Returns:

  • (String)


1424
1425
1426
1427
1428
1429
1430
1431
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1424

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

#usernameString

The username for the user.

Returns:

  • (String)


1424
1425
1426
1427
1428
1429
1430
1431
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1424

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