Struct aws_sdk_cognitoidentityprovider::operation::admin_update_user_attributes::builders::AdminUpdateUserAttributesInputBuilder
source · #[non_exhaustive]pub struct AdminUpdateUserAttributesInputBuilder { /* private fields */ }
Expand description
A builder for AdminUpdateUserAttributesInput
.
Implementations§
source§impl AdminUpdateUserAttributesInputBuilder
impl AdminUpdateUserAttributesInputBuilder
sourcepub fn user_pool_id(self, input: impl Into<String>) -> Self
pub fn user_pool_id(self, input: impl Into<String>) -> Self
The user pool ID for the user pool where you want to update user attributes.
This field is required.sourcepub fn set_user_pool_id(self, input: Option<String>) -> Self
pub fn set_user_pool_id(self, input: Option<String>) -> Self
The user pool ID for the user pool where you want to update user attributes.
sourcepub fn get_user_pool_id(&self) -> &Option<String>
pub fn get_user_pool_id(&self) -> &Option<String>
The user pool ID for the user pool where you want to update user attributes.
sourcepub fn username(self, input: impl Into<String>) -> Self
pub fn username(self, input: impl Into<String>) -> Self
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 set_username(self, input: Option<String>) -> Self
pub fn set_username(self, input: Option<String>) -> Self
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 get_username(&self) -> &Option<String>
pub fn get_username(&self) -> &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.
sourcepub fn user_attributes(self, input: AttributeType) -> Self
pub fn user_attributes(self, input: AttributeType) -> Self
Appends an item to user_attributes
.
To override the contents of this collection use set_user_attributes
.
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.
sourcepub fn set_user_attributes(self, input: Option<Vec<AttributeType>>) -> Self
pub fn set_user_attributes(self, input: Option<Vec<AttributeType>>) -> Self
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.
sourcepub fn get_user_attributes(&self) -> &Option<Vec<AttributeType>>
pub fn get_user_attributes(&self) -> &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.
sourcepub fn client_metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn client_metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to client_metadata
.
To override the contents of this collection use set_client_metadata
.
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.
sourcepub fn set_client_metadata(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_client_metadata(self, input: Option<HashMap<String, String>>) -> Self
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.
sourcepub fn get_client_metadata(&self) -> &Option<HashMap<String, String>>
pub fn get_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.
sourcepub fn build(self) -> Result<AdminUpdateUserAttributesInput, BuildError>
pub fn build(self) -> Result<AdminUpdateUserAttributesInput, BuildError>
Consumes the builder and constructs a AdminUpdateUserAttributesInput
.
source§impl AdminUpdateUserAttributesInputBuilder
impl AdminUpdateUserAttributesInputBuilder
sourcepub async fn send_with(
self,
client: &Client,
) -> Result<AdminUpdateUserAttributesOutput, SdkError<AdminUpdateUserAttributesError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<AdminUpdateUserAttributesOutput, SdkError<AdminUpdateUserAttributesError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for AdminUpdateUserAttributesInputBuilder
impl Clone for AdminUpdateUserAttributesInputBuilder
source§fn clone(&self) -> AdminUpdateUserAttributesInputBuilder
fn clone(&self) -> AdminUpdateUserAttributesInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for AdminUpdateUserAttributesInputBuilder
impl Default for AdminUpdateUserAttributesInputBuilder
source§fn default() -> AdminUpdateUserAttributesInputBuilder
fn default() -> AdminUpdateUserAttributesInputBuilder
source§impl PartialEq for AdminUpdateUserAttributesInputBuilder
impl PartialEq for AdminUpdateUserAttributesInputBuilder
source§fn eq(&self, other: &AdminUpdateUserAttributesInputBuilder) -> bool
fn eq(&self, other: &AdminUpdateUserAttributesInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for AdminUpdateUserAttributesInputBuilder
Auto Trait Implementations§
impl Freeze for AdminUpdateUserAttributesInputBuilder
impl RefUnwindSafe for AdminUpdateUserAttributesInputBuilder
impl Send for AdminUpdateUserAttributesInputBuilder
impl Sync for AdminUpdateUserAttributesInputBuilder
impl Unpin for AdminUpdateUserAttributesInputBuilder
impl UnwindSafe for AdminUpdateUserAttributesInputBuilder
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