Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface GetUserAttributeVerificationCodeRequest.Builder

    • Method Detail

      • accessToken

        GetUserAttributeVerificationCodeRequest.Builder accessToken​(String accessToken)

        A non-expired access token for the user whose attribute verification code you want to generate.

        Parameters:
        accessToken - A non-expired access token for the user whose attribute verification code you want to generate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • attributeName

        GetUserAttributeVerificationCodeRequest.Builder attributeName​(String attributeName)

        The attribute name returned by the server response to get the user attribute verification code.

        Parameters:
        attributeName - The attribute name returned by the server response to get the user attribute verification code.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientMetadata

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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.