Struct rusoto_cognito_idp::ConfirmSignUpRequest
source · [−]pub struct ConfirmSignUpRequest {
pub analytics_metadata: Option<AnalyticsMetadataType>,
pub client_id: String,
pub client_metadata: Option<HashMap<String, String>>,
pub confirmation_code: String,
pub force_alias_creation: Option<bool>,
pub secret_hash: Option<String>,
pub user_context_data: Option<UserContextDataType>,
pub username: String,
}
Expand description
Represents the request to confirm registration of a user.
Fields
analytics_metadata: Option<AnalyticsMetadataType>
The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp
calls.
client_id: String
The ID of the app client associated with the user pool.
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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation 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 ConfirmSignUp 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.
confirmation_code: String
The confirmation code sent by a user's request to confirm registration.
force_alias_creation: Option<bool>
Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False
. If this parameter is set to True
and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False
, the API will throw an AliasExistsException error.
secret_hash: Option<String>
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
user_context_data: Option<UserContextDataType>
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
username: String
The user name of the user whose registration you wish to confirm.
Trait Implementations
sourceimpl Clone for ConfirmSignUpRequest
impl Clone for ConfirmSignUpRequest
sourcefn clone(&self) -> ConfirmSignUpRequest
fn clone(&self) -> ConfirmSignUpRequest
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 Debug for ConfirmSignUpRequest
impl Debug for ConfirmSignUpRequest
sourceimpl Default for ConfirmSignUpRequest
impl Default for ConfirmSignUpRequest
sourcefn default() -> ConfirmSignUpRequest
fn default() -> ConfirmSignUpRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<ConfirmSignUpRequest> for ConfirmSignUpRequest
impl PartialEq<ConfirmSignUpRequest> for ConfirmSignUpRequest
sourcefn eq(&self, other: &ConfirmSignUpRequest) -> bool
fn eq(&self, other: &ConfirmSignUpRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ConfirmSignUpRequest) -> bool
fn ne(&self, other: &ConfirmSignUpRequest) -> bool
This method tests for !=
.
sourceimpl Serialize for ConfirmSignUpRequest
impl Serialize for ConfirmSignUpRequest
impl StructuralPartialEq for ConfirmSignUpRequest
Auto Trait Implementations
impl RefUnwindSafe for ConfirmSignUpRequest
impl Send for ConfirmSignUpRequest
impl Sync for ConfirmSignUpRequest
impl Unpin for ConfirmSignUpRequest
impl UnwindSafe for ConfirmSignUpRequest
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