Interface GetUserAttributeVerificationCodeRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<GetUserAttributeVerificationCodeRequest.Builder,
,GetUserAttributeVerificationCodeRequest> SdkBuilder<GetUserAttributeVerificationCodeRequest.Builder,
,GetUserAttributeVerificationCodeRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetUserAttributeVerificationCodeRequest
-
Method Summary
Modifier and TypeMethodDescriptionaccessToken
(String accessToken) A valid access token that Amazon Cognito issued to the currently signed-in user.attributeName
(String attributeName) The name of the attribute that the user wants to verify, for exampleemail
.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 triggers.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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, sdkFieldNameToField, sdkFields
-
Method Details
-
accessToken
A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
aws.cognito.signin.user.admin
.- Parameters:
accessToken
- A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim foraws.cognito.signin.user.admin
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributeName
The name of the attribute that the user wants to verify, for example
email
.- Parameters:
attributeName
- The name of the attribute that the user wants to verify, for exampleemail
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode request. In your function code in Lambda, you can process theclientMetadata
value to enhance your workflow for your specific needs.For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.
When you use the
ClientMetadata
parameter, note 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, theClientMetadata
parameter serves no purpose. -
Validate the
ClientMetadata
value. -
Encrypt the
ClientMetadata
value. Don't send sensitive information in this parameter.
- 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 GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode request. In your function code in Lambda, you can process theclientMetadata
value to enhance your workflow for your specific needs.For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.
When you use the
ClientMetadata
parameter, note 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, theClientMetadata
parameter serves no purpose. -
Validate the
ClientMetadata
value. -
Encrypt the
ClientMetadata
value. Don't send sensitive information in this parameter.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
GetUserAttributeVerificationCodeRequest.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
GetUserAttributeVerificationCodeRequest.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.
-