Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Calling this action requires developer credentials.

Creating a Request

data AdminDeleteUserAttributes Source #

Represents the request to delete user attributes as an administrator.

See: newAdminDeleteUserAttributes smart constructor.

Constructors

AdminDeleteUserAttributes'
Fields userPoolId :: Text The user pool ID for the user pool where you want to delete user attributes. username :: Sensitive Text The user name of the user from which you would like to delete attributes. userAttributeNames :: [Text] 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.

Instances

Instances details

ToJSON AdminDeleteUserAttributes Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Methods toJSON :: AdminDeleteUserAttributes -> Value # toEncoding :: AdminDeleteUserAttributes -> Encoding # toJSONList :: [AdminDeleteUserAttributes] -> Value # toEncodingList :: [AdminDeleteUserAttributes] -> Encoding #
ToHeaders AdminDeleteUserAttributes Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Methods toHeaders :: AdminDeleteUserAttributes -> [Header] #
ToPath AdminDeleteUserAttributes Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Methods toPath :: AdminDeleteUserAttributes -> ByteString #
ToQuery AdminDeleteUserAttributes Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Methods toQuery :: AdminDeleteUserAttributes -> QueryString #
AWSRequest AdminDeleteUserAttributes Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Associated Types type AWSResponse AdminDeleteUserAttributes # Methods request :: (Service -> Service) -> AdminDeleteUserAttributes -> Request AdminDeleteUserAttributes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AdminDeleteUserAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AdminDeleteUserAttributes))) #
Generic AdminDeleteUserAttributes Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Associated Types type Rep AdminDeleteUserAttributes :: Type -> Type # Methods from :: AdminDeleteUserAttributes -> Rep AdminDeleteUserAttributes x # to :: Rep AdminDeleteUserAttributes x -> AdminDeleteUserAttributes #
Show AdminDeleteUserAttributes Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Methods showsPrec :: Int -> AdminDeleteUserAttributes -> ShowS # show :: AdminDeleteUserAttributes -> String # showList :: [AdminDeleteUserAttributes] -> ShowS #
NFData AdminDeleteUserAttributes Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Methods rnf :: AdminDeleteUserAttributes -> () #
Eq AdminDeleteUserAttributes Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Methods (==) :: AdminDeleteUserAttributes -> AdminDeleteUserAttributes -> Bool # (/=) :: AdminDeleteUserAttributes -> AdminDeleteUserAttributes -> Bool #
Hashable AdminDeleteUserAttributes Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Methods hashWithSalt :: Int -> AdminDeleteUserAttributes -> Int # hash :: AdminDeleteUserAttributes -> Int #
type AWSResponse AdminDeleteUserAttributes Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes type AWSResponse AdminDeleteUserAttributes = AdminDeleteUserAttributesResponse
type Rep AdminDeleteUserAttributes Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes type Rep AdminDeleteUserAttributes = D1 ('MetaData "AdminDeleteUserAttributes" "Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AdminDeleteUserAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: S1 ('MetaSel ('Just "userAttributeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newAdminDeleteUserAttributes Source #

Arguments

:: Text	`AdminDeleteUserAttributes`
-> Text	`AdminDeleteUserAttributes`
-> 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:

AdminDeleteUserAttributes, adminDeleteUserAttributes_userPoolId - The user pool ID for the user pool where you want to delete user attributes.

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 want 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 want 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 httpStatus :: Int The response's http status code.

Instances

Instances details

Generic AdminDeleteUserAttributesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Associated Types type Rep AdminDeleteUserAttributesResponse :: Type -> Type # Methods from :: AdminDeleteUserAttributesResponse -> Rep AdminDeleteUserAttributesResponse x # to :: Rep AdminDeleteUserAttributesResponse x -> AdminDeleteUserAttributesResponse #
Read AdminDeleteUserAttributesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Methods readsPrec :: Int -> ReadS AdminDeleteUserAttributesResponse # readList :: ReadS [AdminDeleteUserAttributesResponse] # readPrec :: ReadPrec AdminDeleteUserAttributesResponse # readListPrec :: ReadPrec [AdminDeleteUserAttributesResponse] #
Show AdminDeleteUserAttributesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Methods showsPrec :: Int -> AdminDeleteUserAttributesResponse -> ShowS # show :: AdminDeleteUserAttributesResponse -> String # showList :: [AdminDeleteUserAttributesResponse] -> ShowS #
NFData AdminDeleteUserAttributesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Methods rnf :: AdminDeleteUserAttributesResponse -> () #
Eq AdminDeleteUserAttributesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes Methods (==) :: AdminDeleteUserAttributesResponse -> AdminDeleteUserAttributesResponse -> Bool # (/=) :: AdminDeleteUserAttributesResponse -> AdminDeleteUserAttributesResponse -> Bool #
type Rep AdminDeleteUserAttributesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes type Rep AdminDeleteUserAttributesResponse = D1 ('MetaData "AdminDeleteUserAttributesResponse" "Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AdminDeleteUserAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAdminDeleteUserAttributesResponse Source #

Arguments

:: Int	`$sel:httpStatus:AdminDeleteUserAttributesResponse'`
-> 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.