[ aws . cognito-idp ]
Deletes the user attributes in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
admin-delete-user-attributes
--user-pool-id <value>
--username <value>
--user-attribute-names <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--user-pool-id
(string)
The user pool ID for the user pool where you want to delete user attributes.
--username
(string)
The user name of the user from which you would like to delete attributes.
--user-attribute-names
(list)
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.(string)
Syntax:
"string" "string" ...
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To delete a user attribute
This example deletes a custom attribute CustomAttr1 for user diego@example.com.
Command:
aws cognito-idp admin-delete-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attribute-names "custom:CustomAttr1"
None