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

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

Overview

Represents the request to get user attribute verification.

See Also:

Constant Summary collapse

SENSITIVE = 
[:access_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

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

Returns:

  • (String) 


5132
5133
5134
5135
5136
5137
5138
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5132

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

#attribute_name ⇒ String

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

Returns:

  • (String) 


5132
5133
5134
5135
5136
5137
5138
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5132

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 [ Customizing user pool Workflows with Lambda Triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> 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.

</note>

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

Returns:

  • (Hash<String,String>) 


5132
5133
5134
5135
5136
5137
5138
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5132

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