Struct GetUserAttributeVerificationCodeInput

#[non_exhaustive]
pub struct GetUserAttributeVerificationCodeInput {
    pub access_token: Option<String>,
    pub attribute_name: Option<String>,
    pub client_metadata: Option<HashMap<String, String>>,
}

Represents the request to get user attribute verification.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

access_token: Option<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.

attribute_name: Option<String>

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

client_metadata: Option<HashMap<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.

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.

Implementations

impl GetUserAttributeVerificationCodeInput

pub fn access_token(&self) -> Option<&str>

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.

pub fn attribute_name(&self) -> Option<&str>

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

pub fn client_metadata(&self) -> Option<&HashMap<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.

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.

impl GetUserAttributeVerificationCodeInput

pub fn builder() -> GetUserAttributeVerificationCodeInputBuilder

Creates a new builder-style object to manufacture GetUserAttributeVerificationCodeInput.

Trait Implementations

impl Clone for GetUserAttributeVerificationCodeInput

fn clone(&self) -> GetUserAttributeVerificationCodeInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetUserAttributeVerificationCodeInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetUserAttributeVerificationCodeInput

fn eq(&self, other: &GetUserAttributeVerificationCodeInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetUserAttributeVerificationCodeInput