pub struct GetUserAttributeVerificationCodeRequest {
pub access_token: String,
pub attribute_name: String,
pub client_metadata: Option<HashMap<String, String>>,
}
Expand description
Represents the request to get user attribute verification.
Fields
access_token: String
The access token returned by the server response to get the user attribute verification code.
attribute_name: 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 AWS 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 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.
Trait Implementations
sourceimpl Clone for GetUserAttributeVerificationCodeRequest
impl Clone for GetUserAttributeVerificationCodeRequest
sourcefn clone(&self) -> GetUserAttributeVerificationCodeRequest
fn clone(&self) -> GetUserAttributeVerificationCodeRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Default for GetUserAttributeVerificationCodeRequest
impl Default for GetUserAttributeVerificationCodeRequest
sourcefn default() -> GetUserAttributeVerificationCodeRequest
fn default() -> GetUserAttributeVerificationCodeRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<GetUserAttributeVerificationCodeRequest> for GetUserAttributeVerificationCodeRequest
impl PartialEq<GetUserAttributeVerificationCodeRequest> for GetUserAttributeVerificationCodeRequest
sourcefn eq(&self, other: &GetUserAttributeVerificationCodeRequest) -> bool
fn eq(&self, other: &GetUserAttributeVerificationCodeRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GetUserAttributeVerificationCodeRequest) -> bool
fn ne(&self, other: &GetUserAttributeVerificationCodeRequest) -> bool
This method tests for !=
.
impl StructuralPartialEq for GetUserAttributeVerificationCodeRequest
Auto Trait Implementations
impl RefUnwindSafe for GetUserAttributeVerificationCodeRequest
impl Send for GetUserAttributeVerificationCodeRequest
impl Sync for GetUserAttributeVerificationCodeRequest
impl Unpin for GetUserAttributeVerificationCodeRequest
impl UnwindSafe for GetUserAttributeVerificationCodeRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more