Class: Aws::CognitoIdentityProvider::Types::GetUserAttributeVerificationCodeRequest

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::GetUserAttributeVerificationCodeRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Represents the request to get user attribute verification.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:access_token]

Instance Attribute Summary

• #access_token ⇒ String

  A valid access token that Amazon Cognito issued to the currently signed-in user.

• #attribute_name ⇒ String

  The name of the attribute that the user wants to verify, for example ‘email`.

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

Instance Attribute Details

#access_token ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6244

class GetUserAttributeVerificationCodeRequest < Struct.new(
  :access_token,
  :attribute_name,
  :client_metadata)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#attribute_name ⇒ String

The name of the attribute that the user wants to verify, for example ‘email`.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6244

class GetUserAttributeVerificationCodeRequest < Struct.new(
  :access_token,
  :attribute_name,
  :client_metadata)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

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

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 [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> 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, the `ClientMetadata` parameter serves no purpose.

• Validate the ‘ClientMetadata` value.

• Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6244

class GetUserAttributeVerificationCodeRequest < Struct.new(
  :access_token,
  :attribute_name,
  :client_metadata)
  SENSITIVE = [:access_token]
  include Aws::Structure
end