[−][src]Struct rusoto_cognito_idp::AdminConfirmSignUpRequest
Represents the request to confirm user registration.
Fields
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.
If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS 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 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.
user_pool_id: String
The user pool ID for which you want to confirm user registration.
username: String
The user name for which you want to confirm user registration.
Trait Implementations
impl Clone for AdminConfirmSignUpRequest
[src]
pub fn clone(&self) -> AdminConfirmSignUpRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for AdminConfirmSignUpRequest
[src]
impl Default for AdminConfirmSignUpRequest
[src]
pub fn default() -> AdminConfirmSignUpRequest
[src]
impl PartialEq<AdminConfirmSignUpRequest> for AdminConfirmSignUpRequest
[src]
pub fn eq(&self, other: &AdminConfirmSignUpRequest) -> bool
[src]
pub fn ne(&self, other: &AdminConfirmSignUpRequest) -> bool
[src]
impl Serialize for AdminConfirmSignUpRequest
[src]
pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralPartialEq for AdminConfirmSignUpRequest
[src]
Auto Trait Implementations
impl RefUnwindSafe for AdminConfirmSignUpRequest
[src]
impl Send for AdminConfirmSignUpRequest
[src]
impl Sync for AdminConfirmSignUpRequest
[src]
impl Unpin for AdminConfirmSignUpRequest
[src]
impl UnwindSafe for AdminConfirmSignUpRequest
[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, 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>,