cognitoidentityprovider_admin_delete_user_attributes: Deletes the user attributes in a user pool as an...

View source: R/cognitoidentityprovider_operations.R

cognitoidentityprovider_admin_delete_user_attributesR Documentation

Deletes the user attributes in a user pool as an administrator

Description

Deletes the user attributes in a user pool as an administrator. Works on any user.

See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_admin_delete_user_attributes/ for full documentation.

Usage

cognitoidentityprovider_admin_delete_user_attributes(
  UserPoolId,
  Username,
  UserAttributeNames
)

Arguments

UserPoolId

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

Username

[required] 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.

UserAttributeNames

[required] 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.


paws.security.identity documentation built on Sept. 12, 2024, 6:30 a.m.