Struct aws_sdk_cognitoidentityprovider::operation::get_user_attribute_verification_code::builders::GetUserAttributeVerificationCodeInputBuilder
source · #[non_exhaustive]pub struct GetUserAttributeVerificationCodeInputBuilder { /* private fields */ }
Expand description
A builder for GetUserAttributeVerificationCodeInput
.
Implementations§
source§impl GetUserAttributeVerificationCodeInputBuilder
impl GetUserAttributeVerificationCodeInputBuilder
sourcepub fn access_token(self, input: impl Into<String>) -> Self
pub fn access_token(self, input: impl Into<String>) -> Self
A non-expired access token for the user whose attribute verification code you want to generate.
This field is required.sourcepub fn set_access_token(self, input: Option<String>) -> Self
pub fn set_access_token(self, input: Option<String>) -> Self
A non-expired access token for the user whose attribute verification code you want to generate.
sourcepub fn get_access_token(&self) -> &Option<String>
pub fn get_access_token(&self) -> &Option<String>
A non-expired access token for the user whose attribute verification code you want to generate.
sourcepub fn attribute_name(self, input: impl Into<String>) -> Self
pub fn attribute_name(self, input: impl Into<String>) -> Self
The attribute name returned by the server response to get the user attribute verification code.
This field is required.sourcepub fn set_attribute_name(self, input: Option<String>) -> Self
pub fn set_attribute_name(self, input: Option<String>) -> Self
The attribute name returned by the server response to get the user attribute verification code.
sourcepub fn get_attribute_name(&self) -> &Option<String>
pub fn get_attribute_name(&self) -> &Option<String>
The attribute name returned by the server response to get the user attribute verification code.
sourcepub fn client_metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn client_metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to client_metadata
.
To override the contents of this collection use set_client_metadata
.
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.
sourcepub fn set_client_metadata(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_client_metadata(self, input: Option<HashMap<String, String>>) -> Self
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.
sourcepub fn get_client_metadata(&self) -> &Option<HashMap<String, String>>
pub fn get_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.
sourcepub fn build(self) -> Result<GetUserAttributeVerificationCodeInput, BuildError>
pub fn build(self) -> Result<GetUserAttributeVerificationCodeInput, BuildError>
Consumes the builder and constructs a GetUserAttributeVerificationCodeInput
.
source§impl GetUserAttributeVerificationCodeInputBuilder
impl GetUserAttributeVerificationCodeInputBuilder
sourcepub async fn send_with(
self,
client: &Client,
) -> Result<GetUserAttributeVerificationCodeOutput, SdkError<GetUserAttributeVerificationCodeError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<GetUserAttributeVerificationCodeOutput, SdkError<GetUserAttributeVerificationCodeError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for GetUserAttributeVerificationCodeInputBuilder
impl Clone for GetUserAttributeVerificationCodeInputBuilder
source§fn clone(&self) -> GetUserAttributeVerificationCodeInputBuilder
fn clone(&self) -> GetUserAttributeVerificationCodeInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for GetUserAttributeVerificationCodeInputBuilder
impl Default for GetUserAttributeVerificationCodeInputBuilder
source§fn default() -> GetUserAttributeVerificationCodeInputBuilder
fn default() -> GetUserAttributeVerificationCodeInputBuilder
source§impl PartialEq for GetUserAttributeVerificationCodeInputBuilder
impl PartialEq for GetUserAttributeVerificationCodeInputBuilder
source§fn eq(&self, other: &GetUserAttributeVerificationCodeInputBuilder) -> bool
fn eq(&self, other: &GetUserAttributeVerificationCodeInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for GetUserAttributeVerificationCodeInputBuilder
Auto Trait Implementations§
impl Freeze for GetUserAttributeVerificationCodeInputBuilder
impl RefUnwindSafe for GetUserAttributeVerificationCodeInputBuilder
impl Send for GetUserAttributeVerificationCodeInputBuilder
impl Sync for GetUserAttributeVerificationCodeInputBuilder
impl Unpin for GetUserAttributeVerificationCodeInputBuilder
impl UnwindSafe for GetUserAttributeVerificationCodeInputBuilder
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