Struct rusoto_cognito_idp::SignUpRequest
source · [−]pub struct SignUpRequest {
pub analytics_metadata: Option<AnalyticsMetadataType>,
pub client_id: String,
pub client_metadata: Option<HashMap<String, String>>,
pub password: String,
pub secret_hash: Option<String>,
pub user_attributes: Option<Vec<AttributeType>>,
pub user_context_data: Option<UserContextDataType>,
pub username: String,
pub validation_data: Option<Vec<AttributeType>>,
}
Expand description
Represents the request to register a user.
Fields
analytics_metadata: Option<AnalyticsMetadataType>
The Amazon Pinpoint analytics metadata for collecting metrics for SignUp
calls.
client_id: String
The ID of the 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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, 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 SignUp 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.
password: String
The password of the user you wish to register.
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_attributes: Option<Vec<AttributeType>>
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
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 you wish to register.
validation_data: Option<Vec<AttributeType>>
The validation data in the request to register a user.
Trait Implementations
sourceimpl Clone for SignUpRequest
impl Clone for SignUpRequest
sourcefn clone(&self) -> SignUpRequest
fn clone(&self) -> SignUpRequest
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 SignUpRequest
impl Debug for SignUpRequest
sourceimpl Default for SignUpRequest
impl Default for SignUpRequest
sourcefn default() -> SignUpRequest
fn default() -> SignUpRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<SignUpRequest> for SignUpRequest
impl PartialEq<SignUpRequest> for SignUpRequest
sourcefn eq(&self, other: &SignUpRequest) -> bool
fn eq(&self, other: &SignUpRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &SignUpRequest) -> bool
fn ne(&self, other: &SignUpRequest) -> bool
This method tests for !=
.
sourceimpl Serialize for SignUpRequest
impl Serialize for SignUpRequest
impl StructuralPartialEq for SignUpRequest
Auto Trait Implementations
impl RefUnwindSafe for SignUpRequest
impl Send for SignUpRequest
impl Sync for SignUpRequest
impl Unpin for SignUpRequest
impl UnwindSafe for SignUpRequest
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