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

Description Usage Arguments Details Request syntax

View source: R/cognitoidentityprovider_operations.R

Description

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

Usage

1
2
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 user name of the user from which you would like to delete attributes.

UserAttributeNames

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

Details

Requires developer credentials.

Request syntax

1
2
3
4
5
6
7
svc$admin_delete_user_attributes(
  UserPoolId = "string",
  Username = "string",
  UserAttributeNames = list(
    "string"
  )
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.