Class: Aws::CognitoIdentityProvider::Types::ResendConfirmationCodeRequest

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 ResendConfirmationCodeRequest data as a hash:

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

Represents the request to resend the confirmation code.

Constant Summary collapse

SENSITIVE =
[:client_id, :secret_hash, :username]

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadataTypes::AnalyticsMetadataType

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



7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7090

class ResendConfirmationCodeRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username]
  include Aws::Structure
end

#client_idString

The ID of the client associated with the user pool.

Returns:

  • (String)


7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7090

class ResendConfirmationCodeRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username]
  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 ResendConfirmationCode 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 ResendConfirmationCode 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>)


7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7090

class ResendConfirmationCodeRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username]
  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)


7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7090

class ResendConfirmationCodeRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username]
  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.



7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7090

class ResendConfirmationCodeRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username]
  include Aws::Structure
end

#usernameString

The user name of the user to whom you wish to resend a confirmation code.

Returns:

  • (String)


7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7090

class ResendConfirmationCodeRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username]
  include Aws::Structure
end