pub struct AdminUpdateUserAttributesRequest {
pub client_metadata: Option<HashMap<String, String>>,
pub user_attributes: Vec<AttributeType>,
pub user_pool_id: String,
pub username: String,
}
Expand description
Represents the request to update the user's attributes as an administrator.
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.
You create custom workflows by assigning AWS 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 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_attributes: 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_pool_id: String
The user pool ID for the user pool where you want to update user attributes.
username: String
The user name of the user for whom you want to update user attributes.
Trait Implementations
sourceimpl Clone for AdminUpdateUserAttributesRequest
impl Clone for AdminUpdateUserAttributesRequest
sourcefn clone(&self) -> AdminUpdateUserAttributesRequest
fn clone(&self) -> AdminUpdateUserAttributesRequest
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 Default for AdminUpdateUserAttributesRequest
impl Default for AdminUpdateUserAttributesRequest
sourcefn default() -> AdminUpdateUserAttributesRequest
fn default() -> AdminUpdateUserAttributesRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<AdminUpdateUserAttributesRequest> for AdminUpdateUserAttributesRequest
impl PartialEq<AdminUpdateUserAttributesRequest> for AdminUpdateUserAttributesRequest
sourcefn eq(&self, other: &AdminUpdateUserAttributesRequest) -> bool
fn eq(&self, other: &AdminUpdateUserAttributesRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &AdminUpdateUserAttributesRequest) -> bool
fn ne(&self, other: &AdminUpdateUserAttributesRequest) -> bool
This method tests for !=
.
impl StructuralPartialEq for AdminUpdateUserAttributesRequest
Auto Trait Implementations
impl RefUnwindSafe for AdminUpdateUserAttributesRequest
impl Send for AdminUpdateUserAttributesRequest
impl Sync for AdminUpdateUserAttributesRequest
impl Unpin for AdminUpdateUserAttributesRequest
impl UnwindSafe for AdminUpdateUserAttributesRequest
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