Struct aws_sdk_cognitoidentityprovider::operation::get_user_attribute_verification_code::GetUserAttributeVerificationCodeInput
source · #[non_exhaustive]pub struct GetUserAttributeVerificationCodeInput {
pub access_token: Option<String>,
pub attribute_name: Option<String>,
pub client_metadata: Option<HashMap<String, String>>,
}
Expand description
Represents the request to get user attribute verification.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.access_token: Option<String>
A non-expired access token for the user whose attribute verification code you want to generate.
attribute_name: Option<String>
The attribute name returned by the server response to get the user attribute verification code.
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 Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
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.
Implementations§
source§impl GetUserAttributeVerificationCodeInput
impl GetUserAttributeVerificationCodeInput
sourcepub fn access_token(&self) -> Option<&str>
pub fn access_token(&self) -> Option<&str>
A non-expired access token for the user whose attribute verification code you want to generate.
sourcepub fn attribute_name(&self) -> Option<&str>
pub fn attribute_name(&self) -> Option<&str>
The attribute name returned by the server response to get the user attribute verification code.
sourcepub fn client_metadata(&self) -> Option<&HashMap<String, String>>
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 Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
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.
source§impl GetUserAttributeVerificationCodeInput
impl GetUserAttributeVerificationCodeInput
sourcepub fn builder() -> GetUserAttributeVerificationCodeInputBuilder
pub fn builder() -> GetUserAttributeVerificationCodeInputBuilder
Creates a new builder-style object to manufacture GetUserAttributeVerificationCodeInput
.
Trait Implementations§
source§impl Clone for GetUserAttributeVerificationCodeInput
impl Clone for GetUserAttributeVerificationCodeInput
source§fn clone(&self) -> GetUserAttributeVerificationCodeInput
fn clone(&self) -> GetUserAttributeVerificationCodeInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq for GetUserAttributeVerificationCodeInput
impl PartialEq for GetUserAttributeVerificationCodeInput
source§fn eq(&self, other: &GetUserAttributeVerificationCodeInput) -> bool
fn eq(&self, other: &GetUserAttributeVerificationCodeInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for GetUserAttributeVerificationCodeInput
Auto Trait Implementations§
impl Freeze for GetUserAttributeVerificationCodeInput
impl RefUnwindSafe for GetUserAttributeVerificationCodeInput
impl Send for GetUserAttributeVerificationCodeInput
impl Sync for GetUserAttributeVerificationCodeInput
impl Unpin for GetUserAttributeVerificationCodeInput
impl UnwindSafe for GetUserAttributeVerificationCodeInput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more