Smaws_Client_CognitoIdentityProvider.AdminUpdateUserAttributesUpdates the specified user's attributes. To delete an attribute from your user, submit the attribute in your API request with a blank value.
For custom attributes, you must add a custom: prefix to the attribute name, for example custom:department.
This operation can set a user's email address or phone number as verified and permit immediate sign-in in user pools that require verification of these attributes. To do this, set the email_verified or phone_number_verified attribute to true.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
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 Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In 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.
val error_to_string :
[ Smaws_Lib.Protocols.AwsJson.error
| `AliasExistsException of Types.alias_exists_exception
| `InternalErrorException of Types.internal_error_exception
| `InvalidEmailRoleAccessPolicyException of
Types.invalid_email_role_access_policy_exception
| `InvalidLambdaResponseException of Types.invalid_lambda_response_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `InvalidSmsRoleAccessPolicyException of
Types.invalid_sms_role_access_policy_exception
| `InvalidSmsRoleTrustRelationshipException of
Types.invalid_sms_role_trust_relationship_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception
| `UnexpectedLambdaException of Types.unexpected_lambda_exception
| `UserLambdaValidationException of Types.user_lambda_validation_exception
| `UserNotFoundException of Types.user_not_found_exception ] ->
stringval request :
'http_type Smaws_Lib.Context.t ->
Types.admin_update_user_attributes_request ->
(Types.admin_update_user_attributes_response,
[> Smaws_Lib.Protocols.AwsJson.error
| `AliasExistsException of Types.alias_exists_exception
| `InternalErrorException of Types.internal_error_exception
| `InvalidEmailRoleAccessPolicyException of
Types.invalid_email_role_access_policy_exception
| `InvalidLambdaResponseException of
Types.invalid_lambda_response_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `InvalidSmsRoleAccessPolicyException of
Types.invalid_sms_role_access_policy_exception
| `InvalidSmsRoleTrustRelationshipException of
Types.invalid_sms_role_trust_relationship_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception
| `UnexpectedLambdaException of Types.unexpected_lambda_exception
| `UserLambdaValidationException of Types.user_lambda_validation_exception
| `UserNotFoundException of Types.user_not_found_exception ])
Stdlib.resultval request_with_metadata :
'http_type Smaws_Lib.Context.t ->
Types.admin_update_user_attributes_request ->
(Types.admin_update_user_attributes_response Smaws_Lib.Response.t,
[> Smaws_Lib.Protocols.AwsJson.error
| `AliasExistsException of Types.alias_exists_exception
| `InternalErrorException of Types.internal_error_exception
| `InvalidEmailRoleAccessPolicyException of
Types.invalid_email_role_access_policy_exception
| `InvalidLambdaResponseException of
Types.invalid_lambda_response_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `InvalidSmsRoleAccessPolicyException of
Types.invalid_sms_role_access_policy_exception
| `InvalidSmsRoleTrustRelationshipException of
Types.invalid_sms_role_trust_relationship_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception
| `UnexpectedLambdaException of Types.unexpected_lambda_exception
| `UserLambdaValidationException of Types.user_lambda_validation_exception
| `UserNotFoundException of Types.user_not_found_exception ]
* Smaws_Lib.Response.metadata)
Stdlib.result