amazonka-cognito-idp-1.6.0: Amazon Cognito Identity Provider SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoIdentityProvider.AdminDeleteUserAttributes

Contents

Description

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

Requires developer credentials.

Synopsis

Creating a Request

adminDeleteUserAttributes #

Creates a value of AdminDeleteUserAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • aduaUserPoolId - The user pool ID for the user pool where you want to delete user attributes.
  • aduaUsername - The user name of the user from which you would like to delete attributes.
  • aduaUserAttributeNames - 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.

data AdminDeleteUserAttributes #

Represents the request to delete user attributes as an administrator.

See: adminDeleteUserAttributes smart constructor.

Instances

Eq AdminDeleteUserAttributes # 
Data AdminDeleteUserAttributes # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AdminDeleteUserAttributes -> c AdminDeleteUserAttributes #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AdminDeleteUserAttributes #

toConstr :: AdminDeleteUserAttributes -> Constr #

dataTypeOf :: AdminDeleteUserAttributes -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdminDeleteUserAttributes) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AdminDeleteUserAttributes) #

gmapT :: (forall b. Data b => b -> b) -> AdminDeleteUserAttributes -> AdminDeleteUserAttributes #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AdminDeleteUserAttributes -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AdminDeleteUserAttributes -> r #

gmapQ :: (forall d. Data d => d -> u) -> AdminDeleteUserAttributes -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AdminDeleteUserAttributes -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AdminDeleteUserAttributes -> m AdminDeleteUserAttributes #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminDeleteUserAttributes -> m AdminDeleteUserAttributes #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminDeleteUserAttributes -> m AdminDeleteUserAttributes #

Show AdminDeleteUserAttributes # 
Generic AdminDeleteUserAttributes # 
Hashable AdminDeleteUserAttributes # 
ToJSON AdminDeleteUserAttributes # 
NFData AdminDeleteUserAttributes # 
AWSRequest AdminDeleteUserAttributes # 
ToHeaders AdminDeleteUserAttributes # 
ToPath AdminDeleteUserAttributes # 
ToQuery AdminDeleteUserAttributes # 
type Rep AdminDeleteUserAttributes # 
type Rep AdminDeleteUserAttributes = D1 * (MetaData "AdminDeleteUserAttributes" "Network.AWS.CognitoIdentityProvider.AdminDeleteUserAttributes" "amazonka-cognito-idp-1.6.0-HX2vHucaSbyYp7rG4n6Wk" False) (C1 * (MetaCons "AdminDeleteUserAttributes'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_aduaUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_aduaUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text))) (S1 * (MetaSel (Just Symbol "_aduaUserAttributeNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [Text])))))
type Rs AdminDeleteUserAttributes # 

Request Lenses

aduaUserPoolId :: Lens' AdminDeleteUserAttributes Text #

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

aduaUsername :: Lens' AdminDeleteUserAttributes Text #

The user name of the user from which you would like to delete attributes.

aduaUserAttributeNames :: Lens' AdminDeleteUserAttributes [Text] #

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

adminDeleteUserAttributesResponse #

Creates a value of AdminDeleteUserAttributesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data AdminDeleteUserAttributesResponse #

Represents the response received from the server for a request to delete user attributes.

See: adminDeleteUserAttributesResponse smart constructor.

Instances

Eq AdminDeleteUserAttributesResponse # 
Data AdminDeleteUserAttributesResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AdminDeleteUserAttributesResponse -> c AdminDeleteUserAttributesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AdminDeleteUserAttributesResponse #

toConstr :: AdminDeleteUserAttributesResponse -> Constr #

dataTypeOf :: AdminDeleteUserAttributesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdminDeleteUserAttributesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AdminDeleteUserAttributesResponse) #

gmapT :: (forall b. Data b => b -> b) -> AdminDeleteUserAttributesResponse -> AdminDeleteUserAttributesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AdminDeleteUserAttributesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AdminDeleteUserAttributesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> AdminDeleteUserAttributesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AdminDeleteUserAttributesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AdminDeleteUserAttributesResponse -> m AdminDeleteUserAttributesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminDeleteUserAttributesResponse -> m AdminDeleteUserAttributesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminDeleteUserAttributesResponse -> m AdminDeleteUserAttributesResponse #

Read AdminDeleteUserAttributesResponse # 
Show AdminDeleteUserAttributesResponse # 
Generic AdminDeleteUserAttributesResponse # 
NFData AdminDeleteUserAttributesResponse # 
type Rep AdminDeleteUserAttributesResponse # 
type Rep AdminDeleteUserAttributesResponse = D1 * (MetaData "AdminDeleteUserAttributesResponse" "Network.AWS.CognitoIdentityProvider.AdminDeleteUserAttributes" "amazonka-cognito-idp-1.6.0-HX2vHucaSbyYp7rG4n6Wk" True) (C1 * (MetaCons "AdminDeleteUserAttributesResponse'" PrefixI True) (S1 * (MetaSel (Just Symbol "_aduarsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))

Response Lenses