You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AdminDeleteUserAttributesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  user_attribute_names: ["AttributeNameType"], # required
}

Represents the request to delete user attributes as an administrator.

Instance Attribute Summary collapse

Instance Attribute Details

#user_attribute_namesArray<String>

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

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

Returns:

  • (Array<String>)

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

#user_pool_idString

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

Returns:

  • (String)

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

#usernameString

The user name of the user from which you would like to delete attributes.

Returns:

  • (String)

    The user name of the user from which you would like to delete attributes.