[−][src]Struct rusoto_cognito_idp::ConfirmSignUpRequest
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
impl Clone for ConfirmSignUpRequest
[src]
pub fn clone(&self) -> ConfirmSignUpRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for ConfirmSignUpRequest
[src]
impl Default for ConfirmSignUpRequest
[src]
pub fn default() -> ConfirmSignUpRequest
[src]
impl PartialEq<ConfirmSignUpRequest> for ConfirmSignUpRequest
[src]
pub fn eq(&self, other: &ConfirmSignUpRequest) -> bool
[src]
pub fn ne(&self, other: &ConfirmSignUpRequest) -> bool
[src]
impl Serialize for ConfirmSignUpRequest
[src]
pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralPartialEq for ConfirmSignUpRequest
[src]
Auto Trait Implementations
impl RefUnwindSafe for ConfirmSignUpRequest
[src]
impl Send for ConfirmSignUpRequest
[src]
impl Sync for ConfirmSignUpRequest
[src]
impl Unpin for ConfirmSignUpRequest
[src]
impl UnwindSafe for ConfirmSignUpRequest
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,