public static interface UpdateUserAttributesRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<UpdateUserAttributesRequest.Builder,UpdateUserAttributesRequest>
| Modifier and Type | Method and Description |
|---|---|
UpdateUserAttributesRequest.Builder |
accessToken(String accessToken)
The access token for the request to update user attributes.
|
UpdateUserAttributesRequest.Builder |
clientMetadata(Map<String,String> clientMetadata)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action
initiates.
|
UpdateUserAttributesRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
UpdateUserAttributesRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
UpdateUserAttributesRequest.Builder |
userAttributes(AttributeType... userAttributes)
An array of name-value pairs representing user attributes.
|
UpdateUserAttributesRequest.Builder |
userAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
|
UpdateUserAttributesRequest.Builder |
userAttributes(Consumer<AttributeType.Builder>... userAttributes)
An array of name-value pairs representing user attributes.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildUpdateUserAttributesRequest.Builder userAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
userAttributes - An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
UpdateUserAttributesRequest.Builder userAttributes(AttributeType... userAttributes)
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
userAttributes - An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
UpdateUserAttributesRequest.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.
List.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #userAttributes(List) .userAttributes - a consumer that will call methods on List.Builder #userAttributes(List) UpdateUserAttributesRequest.Builder accessToken(String accessToken)
The access token for the request to update user attributes.
accessToken - The access token for the request to update user attributes.UpdateUserAttributesRequest.Builder clientMetadata(Map<String,String> 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.
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.
UpdateUserAttributesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderUpdateUserAttributesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.