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

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::AdminRemoveUserFromGroupRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:username]

Instance Attribute Summary

• #group_name ⇒ String

  The group name.

• #user_pool_id ⇒ String

  The user pool ID for the user pool.

• #username ⇒ String

  The username of the user that you want to query or modify.

Instance Attribute Details

#group_name ⇒ String

The group name.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1498

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)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1498

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)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1498

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