Struct aws_sdk_cognitoidentityprovider::operation::admin_update_user_attributes::AdminUpdateUserAttributesInput
source · #[non_exhaustive]pub struct AdminUpdateUserAttributesInput {
pub user_pool_id: Option<String>,
pub username: Option<String>,
pub user_attributes: Option<Vec<AttributeType>>,
pub client_metadata: Option<HashMap<String, String>>,
}
Expand description
Represents the request to update the user's attributes as an administrator.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.user_pool_id: Option<String>
The user pool ID for the user pool where you want to update user attributes.
username: 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.
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.
If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
To update the value of an attribute that requires verification in the same API request, include the email_verified
or phone_number_verified
attribute, with a value of true
. If you set the email_verified
or phone_number_verified
value for an email
or phone_number
attribute that requires verification to true
, Amazon Cognito doesn’t send a verification message to your user.
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 Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminUpdateUserAttributes 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.
Implementations§
source§impl AdminUpdateUserAttributesInput
impl AdminUpdateUserAttributesInput
sourcepub fn user_pool_id(&self) -> Option<&str>
pub fn user_pool_id(&self) -> Option<&str>
The user pool ID for the user pool where you want to update user attributes.
sourcepub fn username(&self) -> Option<&str>
pub fn username(&self) -> Option<&str>
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 user_attributes(&self) -> &[AttributeType]
pub fn user_attributes(&self) -> &[AttributeType]
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
To update the value of an attribute that requires verification in the same API request, include the email_verified
or phone_number_verified
attribute, with a value of true
. If you set the email_verified
or phone_number_verified
value for an email
or phone_number
attribute that requires verification to true
, Amazon Cognito doesn’t send a verification message to your user.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .user_attributes.is_none()
.
sourcepub fn client_metadata(&self) -> Option<&HashMap<String, String>>
pub fn 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.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message 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 AdminUpdateUserAttributes 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.
source§impl AdminUpdateUserAttributesInput
impl AdminUpdateUserAttributesInput
sourcepub fn builder() -> AdminUpdateUserAttributesInputBuilder
pub fn builder() -> AdminUpdateUserAttributesInputBuilder
Creates a new builder-style object to manufacture AdminUpdateUserAttributesInput
.
Trait Implementations§
source§impl Clone for AdminUpdateUserAttributesInput
impl Clone for AdminUpdateUserAttributesInput
source§fn clone(&self) -> AdminUpdateUserAttributesInput
fn clone(&self) -> AdminUpdateUserAttributesInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq for AdminUpdateUserAttributesInput
impl PartialEq for AdminUpdateUserAttributesInput
source§fn eq(&self, other: &AdminUpdateUserAttributesInput) -> bool
fn eq(&self, other: &AdminUpdateUserAttributesInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for AdminUpdateUserAttributesInput
Auto Trait Implementations§
impl Freeze for AdminUpdateUserAttributesInput
impl RefUnwindSafe for AdminUpdateUserAttributesInput
impl Send for AdminUpdateUserAttributesInput
impl Sync for AdminUpdateUserAttributesInput
impl Unpin for AdminUpdateUserAttributesInput
impl UnwindSafe for AdminUpdateUserAttributesInput
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