Struct aws_sdk_cognitoidentityprovider::operation::admin_confirm_sign_up::builders::AdminConfirmSignUpInputBuilder
source · #[non_exhaustive]pub struct AdminConfirmSignUpInputBuilder { /* private fields */ }
Expand description
A builder for AdminConfirmSignUpInput
.
Implementations§
source§impl AdminConfirmSignUpInputBuilder
impl AdminConfirmSignUpInputBuilder
sourcepub fn user_pool_id(self, input: impl Into<String>) -> Self
pub fn user_pool_id(self, input: impl Into<String>) -> Self
The user pool ID for which you want to confirm user registration.
This field is required.sourcepub fn set_user_pool_id(self, input: Option<String>) -> Self
pub fn set_user_pool_id(self, input: Option<String>) -> Self
The user pool ID for which you want to confirm user registration.
sourcepub fn get_user_pool_id(&self) -> &Option<String>
pub fn get_user_pool_id(&self) -> &Option<String>
The user pool ID for which you want to confirm user registration.
sourcepub fn username(self, input: impl Into<String>) -> Self
pub fn username(self, input: impl Into<String>) -> Self
The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username
isn't an alias attribute in your user pool, this value must be the sub
of a local user or the username of a user from a third-party IdP.
sourcepub fn set_username(self, input: Option<String>) -> Self
pub fn set_username(self, input: Option<String>) -> Self
The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username
isn't an alias attribute in your user pool, this value must be the sub
of a local user or the username of a user from a third-party IdP.
sourcepub fn get_username(&self) -> &Option<String>
pub fn get_username(&self) -> &Option<String>
The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username
isn't an alias attribute in your user pool, this value must be the sub
of a local user or the username of a user from a third-party IdP.
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.
If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata
attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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.
If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata
attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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.
If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata
attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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<AdminConfirmSignUpInput, BuildError>
pub fn build(self) -> Result<AdminConfirmSignUpInput, BuildError>
Consumes the builder and constructs a AdminConfirmSignUpInput
.
source§impl AdminConfirmSignUpInputBuilder
impl AdminConfirmSignUpInputBuilder
sourcepub async fn send_with(
self,
client: &Client,
) -> Result<AdminConfirmSignUpOutput, SdkError<AdminConfirmSignUpError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<AdminConfirmSignUpOutput, SdkError<AdminConfirmSignUpError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for AdminConfirmSignUpInputBuilder
impl Clone for AdminConfirmSignUpInputBuilder
source§fn clone(&self) -> AdminConfirmSignUpInputBuilder
fn clone(&self) -> AdminConfirmSignUpInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for AdminConfirmSignUpInputBuilder
impl Default for AdminConfirmSignUpInputBuilder
source§fn default() -> AdminConfirmSignUpInputBuilder
fn default() -> AdminConfirmSignUpInputBuilder
source§impl PartialEq for AdminConfirmSignUpInputBuilder
impl PartialEq for AdminConfirmSignUpInputBuilder
source§fn eq(&self, other: &AdminConfirmSignUpInputBuilder) -> bool
fn eq(&self, other: &AdminConfirmSignUpInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for AdminConfirmSignUpInputBuilder
Auto Trait Implementations§
impl Freeze for AdminConfirmSignUpInputBuilder
impl RefUnwindSafe for AdminConfirmSignUpInputBuilder
impl Send for AdminConfirmSignUpInputBuilder
impl Sync for AdminConfirmSignUpInputBuilder
impl Unpin for AdminConfirmSignUpInputBuilder
impl UnwindSafe for AdminConfirmSignUpInputBuilder
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