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.UpdateUserAttributes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Allows a user to update a specific attribute (one at a time).

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <https:docs.aws.amazon.comsnslatestdgsns-sms-sandbox.html sandbox mode> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

Synopsis

Creating a Request

data UpdateUserAttributes Source #

Represents the request to update user attributes.

See: newUpdateUserAttributes smart constructor.

Constructors

UpdateUserAttributes'

Fields

clientMetadata :: Maybe (HashMap Text Text)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
- Validate the ClientMetadata value.
- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
userAttributes :: [AttributeType]
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
accessToken :: Sensitive Text
A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.

Instances

Instances details

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

newUpdateUserAttributes Source #

Arguments

:: Text	`UpdateUserAttributes`
-> UpdateUserAttributes

Create a value of UpdateUserAttributes 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:clientMetadata:UpdateUserAttributes', updateUserAttributes_clientMetadata - A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

$sel:userAttributes:UpdateUserAttributes', updateUserAttributes_userAttributes - An array of name-value pairs representing user attributes.

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

If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.

UpdateUserAttributes, updateUserAttributes_accessToken - A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.

Request Lenses

updateUserAttributes_clientMetadata :: Lens' UpdateUserAttributes (Maybe (HashMap Text Text)) Source #

A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

updateUserAttributes_userAttributes :: Lens' UpdateUserAttributes [AttributeType] Source #

An array of name-value pairs representing user attributes.

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

If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.

updateUserAttributes_accessToken :: Lens' UpdateUserAttributes Text Source #

A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.

Destructuring the Response

data UpdateUserAttributesResponse Source #

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

See: newUpdateUserAttributesResponse smart constructor.

Constructors

UpdateUserAttributesResponse'
Fields codeDeliveryDetailsList :: Maybe [CodeDeliveryDetailsType] The code delivery details list from the server for the request to update user attributes. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateUserAttributesResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateUserAttributesResponse'`
-> UpdateUserAttributesResponse

Create a value of UpdateUserAttributesResponse 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:codeDeliveryDetailsList:UpdateUserAttributesResponse', updateUserAttributesResponse_codeDeliveryDetailsList - The code delivery details list from the server for the request to update user attributes.

$sel:httpStatus:UpdateUserAttributesResponse', updateUserAttributesResponse_httpStatus - The response's http status code.

Response Lenses

updateUserAttributesResponse_codeDeliveryDetailsList :: Lens' UpdateUserAttributesResponse (Maybe [CodeDeliveryDetailsType]) Source #

The code delivery details list from the server for the request to update user attributes.

updateUserAttributesResponse_httpStatus :: Lens' UpdateUserAttributesResponse Int Source #

The response's http status code.