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

Class: Aws::CognitoIdentityProvider::Types::ConfirmSignUpRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass ConfirmSignUpRequest data as a hash:

{
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  username: "UsernameType", # required
  confirmation_code: "ConfirmationCodeType", # required
  force_alias_creation: false,
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    encoded_data: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
}

Represents the request to confirm registration of a user.

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadataTypes::AnalyticsMetadataType

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.



2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2775

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  include Aws::Structure
end

#client_idString

The ID of the app client associated with the user pool.

Returns:

  • (String)


2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2775

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  include Aws::Structure
end

#client_metadataHash<String,String>

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 AWS Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation 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 ConfirmSignUp 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>)


2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2775

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  include Aws::Structure
end

#confirmation_codeString

The confirmation code sent by a user's request to confirm registration.

Returns:

  • (String)


2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2775

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  include Aws::Structure
end

#force_alias_creationBoolean

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

Returns:

  • (Boolean)


2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2775

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  include Aws::Structure
end

#secret_hashString

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Returns:

  • (String)


2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2775

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  include Aws::Structure
end

#user_context_dataTypes::UserContextDataType

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.



2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2775

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  include Aws::Structure
end

#usernameString

The user name of the user whose registration you wish to confirm.

Returns:

  • (String)


2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2775

class ConfirmSignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :force_alias_creation,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  include Aws::Structure
end