Class: Aws::CognitoIdentityProvider::Types::AdminRemoveUserFromGroupRequest

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

#group_name ⇒ String

The group name.

Returns:

  • (String) 


1322
1323
1324
1325
1326
1327
1328
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1322

class AdminRemoveUserFromGroupRequest < Struct.new(
  :user_pool_id,
  :username,
  :group_name)
  SENSITIVE = [:username]
  include Aws::Structure
end

#user_pool_id ⇒ String

The user pool ID for the user pool.

Returns:

  • (String) 


1322
1323
1324
1325
1326
1327
1328
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1322

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


1322
1323
1324
1325
1326
1327
1328
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1322

class AdminRemoveUserFromGroupRequest < Struct.new(
  :user_pool_id,
  :username,
  :group_name)
  SENSITIVE = [:username]
  include Aws::Structure
end