You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::AdminConfirmSignUpRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AdminConfirmSignUpRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  client_metadata: {
    "StringType" => "StringType",
  },
}

Represents the request to confirm user registration.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_metadata ⇒ Hash<String,String>

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in AWS 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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don\'t use it to provide sensitive information.

Returns:

  • (Hash<String,String>) —

    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

#user_pool_id ⇒ String

The user pool ID for which you want to confirm user registration.

Returns:

  • (String) —

    The user pool ID for which you want to confirm user registration.

#username ⇒ String

The user name for which you want to confirm user registration.

Returns:

  • (String) —

    The user name for which you want to confirm user registration.