Interface AdminUpdateUserAttributesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<AdminUpdateUserAttributesRequest.Builder,
,AdminUpdateUserAttributesRequest> SdkBuilder<AdminUpdateUserAttributesRequest.Builder,
,AdminUpdateUserAttributesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
AdminUpdateUserAttributesRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientMetadata
(Map<String, String> clientMetadata) A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.userAttributes
(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.userAttributes
(Consumer<AttributeType.Builder>... userAttributes) An array of name-value pairs representing user attributes.userAttributes
(AttributeType... userAttributes) An array of name-value pairs representing user attributes.The username of the user that you want to query or modify.userPoolId
(String userPoolId) The user pool ID for the user pool where you want to update user attributes.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
userPoolId
The user pool ID for the user pool where you want to update user attributes.
- Parameters:
userPoolId
- The user pool ID for the user pool where you want to update user attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
username
The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If
username
isn't an alias attribute in your user pool, this value must be thesub
of a local user or the username of a user from a third-party IdP.- Parameters:
username
- The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. Ifusername
isn't an alias attribute in your user pool, this value must be thesub
of a local user or the username of a user from a third-party IdP.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userAttributes
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the
custom:
prefix to the attribute name.If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito 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.
To update the value of an attribute that requires verification in the same API request, include the
email_verified
orphone_number_verified
attribute, with a value oftrue
. If you set theemail_verified
orphone_number_verified
value for anemail
orphone_number
attribute that requires verification totrue
, Amazon Cognito doesn’t send a verification message to your user.- Parameters:
userAttributes
- An array of name-value pairs representing user attributes.For custom attributes, you must prepend the
custom:
prefix to the attribute name.If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito 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.
To update the value of an attribute that requires verification in the same API request, include the
email_verified
orphone_number_verified
attribute, with a value oftrue
. If you set theemail_verified
orphone_number_verified
value for anemail
orphone_number
attribute that requires verification totrue
, Amazon Cognito doesn’t send a verification message to your user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userAttributes
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the
custom:
prefix to the attribute name.If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito 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.
To update the value of an attribute that requires verification in the same API request, include the
email_verified
orphone_number_verified
attribute, with a value oftrue
. If you set theemail_verified
orphone_number_verified
value for anemail
orphone_number
attribute that requires verification totrue
, Amazon Cognito doesn’t send a verification message to your user.- Parameters:
userAttributes
- An array of name-value pairs representing user attributes.For custom attributes, you must prepend the
custom:
prefix to the attribute name.If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito 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.
To update the value of an attribute that requires verification in the same API request, include the
email_verified
orphone_number_verified
attribute, with a value oftrue
. If you set theemail_verified
orphone_number_verified
value for anemail
orphone_number
attribute that requires verification totrue
, Amazon Cognito doesn’t send a verification message to your user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userAttributes
AdminUpdateUserAttributesRequest.Builder userAttributes(Consumer<AttributeType.Builder>... userAttributes) An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the
custom:
prefix to the attribute name.If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito 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.
To update the value of an attribute that requires verification in the same API request, include the
This is a convenience method that creates an instance of theemail_verified
orphone_number_verified
attribute, with a value oftrue
. If you set theemail_verified
orphone_number_verified
value for anemail
orphone_number
attribute that requires verification totrue
, Amazon Cognito doesn’t send a verification message to your user.AttributeType.Builder
avoiding the need to create one manually viaAttributeType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed touserAttributes(List<AttributeType>)
.- Parameters:
userAttributes
- a consumer that will call methods onAttributeType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes 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 AdminUpdateUserAttributes request. In your function code in Lambda, you can process theclientMetadata
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.
- Parameters:
clientMetadata
- A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes 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 AdminUpdateUserAttributes request. In your function code in Lambda, you can process theclientMetadata
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
AdminUpdateUserAttributesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
AdminUpdateUserAttributesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-