amazonka-cognito-idp-1.6.1: 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.AdminUpdateUserAttributes

Contents

Description

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

For custom attributes, you must prepend the custom: prefix to the attribute name.

In addition to updating user attributes, this API can also be used to mark phone and email as verified.

Requires developer credentials.

Synopsis

Creating a Request

adminUpdateUserAttributes Source #

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

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

  • auuaUserPoolId - The user pool ID for the user pool where you want to update user attributes.
  • auuaUsername - The user name of the user for whom you want to update user attributes.
  • auuaUserAttributes - An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name.

data AdminUpdateUserAttributes Source #

Represents the request to update the user's attributes as an administrator.

See: adminUpdateUserAttributes smart constructor.

Instances
Eq AdminUpdateUserAttributes Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

Data AdminUpdateUserAttributes Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

Methods

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

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

toConstr :: AdminUpdateUserAttributes -> Constr #

dataTypeOf :: AdminUpdateUserAttributes -> DataType #

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

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

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

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

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

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

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

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

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

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

Show AdminUpdateUserAttributes Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

Generic AdminUpdateUserAttributes Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

Associated Types

type Rep AdminUpdateUserAttributes :: Type -> Type #

Hashable AdminUpdateUserAttributes Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

ToJSON AdminUpdateUserAttributes Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

AWSRequest AdminUpdateUserAttributes Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

Associated Types

type Rs AdminUpdateUserAttributes :: Type #

ToHeaders AdminUpdateUserAttributes Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

ToPath AdminUpdateUserAttributes Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

ToQuery AdminUpdateUserAttributes Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

NFData AdminUpdateUserAttributes Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

type Rep AdminUpdateUserAttributes Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

type Rep AdminUpdateUserAttributes = D1 (MetaData "AdminUpdateUserAttributes" "Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" False) (C1 (MetaCons "AdminUpdateUserAttributes'" PrefixI True) (S1 (MetaSel (Just "_auuaUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_auuaUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 (MetaSel (Just "_auuaUserAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [AttributeType]))))
type Rs AdminUpdateUserAttributes Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

Request Lenses

auuaUserPoolId :: Lens' AdminUpdateUserAttributes Text Source #

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

auuaUsername :: Lens' AdminUpdateUserAttributes Text Source #

The user name of the user for whom you want to update user attributes.

auuaUserAttributes :: Lens' AdminUpdateUserAttributes [AttributeType] Source #

An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name.

Destructuring the Response

adminUpdateUserAttributesResponse Source #

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

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

data AdminUpdateUserAttributesResponse Source #

Represents the response from the server for the request to update user attributes as an administrator.

See: adminUpdateUserAttributesResponse smart constructor.

Instances
Eq AdminUpdateUserAttributesResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

Data AdminUpdateUserAttributesResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

Methods

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

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

toConstr :: AdminUpdateUserAttributesResponse -> Constr #

dataTypeOf :: AdminUpdateUserAttributesResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read AdminUpdateUserAttributesResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

Show AdminUpdateUserAttributesResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

Generic AdminUpdateUserAttributesResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

Associated Types

type Rep AdminUpdateUserAttributesResponse :: Type -> Type #

NFData AdminUpdateUserAttributesResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

type Rep AdminUpdateUserAttributesResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes

type Rep AdminUpdateUserAttributesResponse = D1 (MetaData "AdminUpdateUserAttributesResponse" "Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" True) (C1 (MetaCons "AdminUpdateUserAttributesResponse'" PrefixI True) (S1 (MetaSel (Just "_auuarsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses