| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes
Description
Deletes the user attributes in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
Synopsis
- data AdminDeleteUserAttributes = AdminDeleteUserAttributes' {
- userPoolId :: Text
- username :: Sensitive Text
- userAttributeNames :: [Text]
- newAdminDeleteUserAttributes :: Text -> Text -> AdminDeleteUserAttributes
- adminDeleteUserAttributes_userPoolId :: Lens' AdminDeleteUserAttributes Text
- adminDeleteUserAttributes_username :: Lens' AdminDeleteUserAttributes Text
- adminDeleteUserAttributes_userAttributeNames :: Lens' AdminDeleteUserAttributes [Text]
- data AdminDeleteUserAttributesResponse = AdminDeleteUserAttributesResponse' {
- httpStatus :: Int
- newAdminDeleteUserAttributesResponse :: Int -> AdminDeleteUserAttributesResponse
- adminDeleteUserAttributesResponse_httpStatus :: Lens' AdminDeleteUserAttributesResponse Int
Creating a Request
data AdminDeleteUserAttributes Source #
Represents the request to delete user attributes as an administrator.
See: newAdminDeleteUserAttributes smart constructor.
Constructors
| AdminDeleteUserAttributes' | |
Fields
| |
Instances
newAdminDeleteUserAttributes Source #
Arguments
| :: Text | |
| -> Text | |
| -> AdminDeleteUserAttributes |
Create a value of AdminDeleteUserAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminDeleteUserAttributes', adminDeleteUserAttributes_userPoolId - The user pool ID for the user pool where you want to delete user
attributes.
$sel:username:AdminDeleteUserAttributes', adminDeleteUserAttributes_username - The user name of the user from which you would like to delete
attributes.
$sel:userAttributeNames:AdminDeleteUserAttributes', adminDeleteUserAttributes_userAttributeNames - 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.
Request Lenses
adminDeleteUserAttributes_userPoolId :: Lens' AdminDeleteUserAttributes Text Source #
The user pool ID for the user pool where you want to delete user attributes.
adminDeleteUserAttributes_username :: Lens' AdminDeleteUserAttributes Text Source #
The user name of the user from which you would like to delete attributes.
adminDeleteUserAttributes_userAttributeNames :: Lens' AdminDeleteUserAttributes [Text] Source #
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.
Destructuring the Response
data AdminDeleteUserAttributesResponse Source #
Represents the response received from the server for a request to delete user attributes.
See: newAdminDeleteUserAttributesResponse smart constructor.
Constructors
| AdminDeleteUserAttributesResponse' | |
Fields
| |
Instances
newAdminDeleteUserAttributesResponse Source #
Arguments
| :: Int | |
| -> AdminDeleteUserAttributesResponse |
Create a value of AdminDeleteUserAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminDeleteUserAttributesResponse', adminDeleteUserAttributesResponse_httpStatus - The response's http status code.
Response Lenses
adminDeleteUserAttributesResponse_httpStatus :: Lens' AdminDeleteUserAttributesResponse Int Source #
The response's http status code.