/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace CognitoIdentityProvider { namespace Model { /** *

Represents the request to update the user's attributes as an * administrator.

*/ class AdminUpdateUserAttributesRequest : public CognitoIdentityProviderRequest { public: AWS_COGNITOIDENTITYPROVIDER_API AdminUpdateUserAttributesRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "AdminUpdateUserAttributes"; } AWS_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override; AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The user pool ID for the user pool where you want to update user * attributes.

*/ inline const Aws::String& GetUserPoolId() const{ return m_userPoolId; } /** *

The user pool ID for the user pool where you want to update user * attributes.

*/ inline bool UserPoolIdHasBeenSet() const { return m_userPoolIdHasBeenSet; } /** *

The user pool ID for the user pool where you want to update user * attributes.

*/ inline void SetUserPoolId(const Aws::String& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = value; } /** *

The user pool ID for the user pool where you want to update user * attributes.

*/ inline void SetUserPoolId(Aws::String&& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = std::move(value); } /** *

The user pool ID for the user pool where you want to update user * attributes.

*/ inline void SetUserPoolId(const char* value) { m_userPoolIdHasBeenSet = true; m_userPoolId.assign(value); } /** *

The user pool ID for the user pool where you want to update user * attributes.

*/ inline AdminUpdateUserAttributesRequest& WithUserPoolId(const Aws::String& value) { SetUserPoolId(value); return *this;} /** *

The user pool ID for the user pool where you want to update user * attributes.

*/ inline AdminUpdateUserAttributesRequest& WithUserPoolId(Aws::String&& value) { SetUserPoolId(std::move(value)); return *this;} /** *

The user pool ID for the user pool where you want to update user * attributes.

*/ inline AdminUpdateUserAttributesRequest& WithUserPoolId(const char* value) { SetUserPoolId(value); return *this;} /** *

The user name of the user for whom you want to update user attributes.

*/ inline const Aws::String& GetUsername() const{ return m_username; } /** *

The user name of the user for whom you want to update user attributes.

*/ inline bool UsernameHasBeenSet() const { return m_usernameHasBeenSet; } /** *

The user name of the user for whom you want to update user attributes.

*/ inline void SetUsername(const Aws::String& value) { m_usernameHasBeenSet = true; m_username = value; } /** *

The user name of the user for whom you want to update user attributes.

*/ inline void SetUsername(Aws::String&& value) { m_usernameHasBeenSet = true; m_username = std::move(value); } /** *

The user name of the user for whom you want to update user attributes.

*/ inline void SetUsername(const char* value) { m_usernameHasBeenSet = true; m_username.assign(value); } /** *

The user name of the user for whom you want to update user attributes.

*/ inline AdminUpdateUserAttributesRequest& WithUsername(const Aws::String& value) { SetUsername(value); return *this;} /** *

The user name of the user for whom you want to update user attributes.

*/ inline AdminUpdateUserAttributesRequest& WithUsername(Aws::String&& value) { SetUsername(std::move(value)); return *this;} /** *

The user name of the user for whom you want to update user attributes.

*/ inline AdminUpdateUserAttributesRequest& WithUsername(const char* value) { SetUsername(value); return *this;} /** *

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.

*/ inline const Aws::Vector& GetUserAttributes() const{ return m_userAttributes; } /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline bool UserAttributesHasBeenSet() const { return m_userAttributesHasBeenSet; } /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline void SetUserAttributes(const Aws::Vector& value) { m_userAttributesHasBeenSet = true; m_userAttributes = value; } /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline void SetUserAttributes(Aws::Vector&& value) { m_userAttributesHasBeenSet = true; m_userAttributes = std::move(value); } /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline AdminUpdateUserAttributesRequest& WithUserAttributes(const Aws::Vector& value) { SetUserAttributes(value); return *this;} /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline AdminUpdateUserAttributesRequest& WithUserAttributes(Aws::Vector&& value) { SetUserAttributes(std::move(value)); return *this;} /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline AdminUpdateUserAttributesRequest& AddUserAttributes(const AttributeType& value) { m_userAttributesHasBeenSet = true; m_userAttributes.push_back(value); return *this; } /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline AdminUpdateUserAttributesRequest& AddUserAttributes(AttributeType&& value) { m_userAttributesHasBeenSet = true; m_userAttributes.push_back(std::move(value)); return *this; } /** *

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.