Class: Aws::CognitoIdentityProvider::Types::AdminDeleteUserAttributesRequest

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

Overview

Represents the request to delete user attributes as an administrator.

See Also:

Constant Summary collapse

SENSITIVE = 
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#user_attribute_names ⇒ Array<String>

An array of strings representing the user attribute names you want to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:

  • (Array<String>) 


646
647
648
649
650
651
652
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 646

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

#user_pool_id ⇒ String

The ID of the user pool where you want to delete user attributes.

Returns:

  • (String) 


646
647
648
649
650
651
652
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 646

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


646
647
648
649
650
651
652
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 646

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