/** * 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 user attributes.

See Also:

* AWS * API Reference

*/ class UpdateUserAttributesRequest : public CognitoIdentityProviderRequest { public: AWS_COGNITOIDENTITYPROVIDER_API UpdateUserAttributesRequest(); // 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 "UpdateUserAttributes"; } AWS_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override; AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

An array of name-value pairs representing user attributes.

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

If you have set an attribute to require verification before Amazon * Cognito updates its value, this request 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.

*/ 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.

If you have set an attribute to require verification before Amazon * Cognito updates its value, this request 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.

*/ 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.

If you have set an attribute to require verification before Amazon * Cognito updates its value, this request 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.

*/ 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.

If you have set an attribute to require verification before Amazon * Cognito updates its value, this request 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.

*/ 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.

If you have set an attribute to require verification before Amazon * Cognito updates its value, this request 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.

*/ inline UpdateUserAttributesRequest& 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.

If you have set an attribute to require verification before Amazon * Cognito updates its value, this request 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.

*/ inline UpdateUserAttributesRequest& 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.

If you have set an attribute to require verification before Amazon * Cognito updates its value, this request 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.

*/ inline UpdateUserAttributesRequest& 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.

If you have set an attribute to require verification before Amazon * Cognito updates its value, this request 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.

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

A valid access token that Amazon Cognito issued to the user whose user * attributes you want to update.

*/ inline const Aws::String& GetAccessToken() const{ return m_accessToken; } /** *

A valid access token that Amazon Cognito issued to the user whose user * attributes you want to update.

*/ inline bool AccessTokenHasBeenSet() const { return m_accessTokenHasBeenSet; } /** *

A valid access token that Amazon Cognito issued to the user whose user * attributes you want to update.

*/ inline void SetAccessToken(const Aws::String& value) { m_accessTokenHasBeenSet = true; m_accessToken = value; } /** *

A valid access token that Amazon Cognito issued to the user whose user * attributes you want to update.

*/ inline void SetAccessToken(Aws::String&& value) { m_accessTokenHasBeenSet = true; m_accessToken = std::move(value); } /** *

A valid access token that Amazon Cognito issued to the user whose user * attributes you want to update.

*/ inline void SetAccessToken(const char* value) { m_accessTokenHasBeenSet = true; m_accessToken.assign(value); } /** *

A valid access token that Amazon Cognito issued to the user whose user * attributes you want to update.

*/ inline UpdateUserAttributesRequest& WithAccessToken(const Aws::String& value) { SetAccessToken(value); return *this;} /** *

A valid access token that Amazon Cognito issued to the user whose user * attributes you want to update.

*/ inline UpdateUserAttributesRequest& WithAccessToken(Aws::String&& value) { SetAccessToken(std::move(value)); return *this;} /** *

A valid access token that Amazon Cognito issued to the user whose user * attributes you want to update.

*/ inline UpdateUserAttributesRequest& WithAccessToken(const char* value) { SetAccessToken(value); return *this;} /** *

A map of custom key-value pairs that you can provide as input for any custom * workflows that this action initiates.

You create custom workflows by * assigning Lambda functions to user pool triggers. When you use the * UpdateUserAttributes 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 * UpdateUserAttributes 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.

*/ inline const Aws::Map& GetClientMetadata() const{ return m_clientMetadata; } /** *

A map of custom key-value pairs that you can provide as input for any custom * workflows that this action initiates.

You create custom workflows by * assigning Lambda functions to user pool triggers. When you use the * UpdateUserAttributes 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 * UpdateUserAttributes 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.

*/ inline bool ClientMetadataHasBeenSet() const { return m_clientMetadataHasBeenSet; } /** *

A map of custom key-value pairs that you can provide as input for any custom * workflows that this action initiates.

You create custom workflows by * assigning Lambda functions to user pool triggers. When you use the * UpdateUserAttributes 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 * UpdateUserAttributes 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.

*/ inline void SetClientMetadata(const Aws::Map& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata = value; } /** *

A map of custom key-value pairs that you can provide as input for any custom * workflows that this action initiates.

You create custom workflows by * assigning Lambda functions to user pool triggers. When you use the * UpdateUserAttributes 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 * UpdateUserAttributes 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.

*/ inline void SetClientMetadata(Aws::Map&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata = std::move(value); } /** *

A map of custom key-value pairs that you can provide as input for any custom * workflows that this action initiates.

You create custom workflows by * assigning Lambda functions to user pool triggers. When you use the * UpdateUserAttributes 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 * UpdateUserAttributes 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.

*/ inline UpdateUserAttributesRequest& WithClientMetadata(const Aws::Map& value) { SetClientMetadata(value); return *this;} /** *

A map of custom key-value pairs that you can provide as input for any custom * workflows that this action initiates.

You create custom workflows by * assigning Lambda functions to user pool triggers. When you use the * UpdateUserAttributes 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 * UpdateUserAttributes 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.

*/ inline UpdateUserAttributesRequest& WithClientMetadata(Aws::Map&& value) { SetClientMetadata(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 initiates.

You create custom workflows by * assigning Lambda functions to user pool triggers. When you use the * UpdateUserAttributes 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 * UpdateUserAttributes 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.

*/ inline UpdateUserAttributesRequest& AddClientMetadata(const Aws::String& key, const Aws::String& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, value); return *this; } /** *

A map of custom key-value pairs that you can provide as input for any custom * workflows that this action initiates.

You create custom workflows by * assigning Lambda functions to user pool triggers. When you use the * UpdateUserAttributes 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 * UpdateUserAttributes 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.

*/ inline UpdateUserAttributesRequest& AddClientMetadata(Aws::String&& key, const Aws::String& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(std::move(key), value); return *this; } /** *

A map of custom key-value pairs that you can provide as input for any custom * workflows that this action initiates.

You create custom workflows by * assigning Lambda functions to user pool triggers. When you use the * UpdateUserAttributes 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 * UpdateUserAttributes 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.

*/ inline UpdateUserAttributesRequest& AddClientMetadata(const Aws::String& key, Aws::String&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, 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 initiates.

You create custom workflows by * assigning Lambda functions to user pool triggers. When you use the * UpdateUserAttributes 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 * UpdateUserAttributes 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.

*/ inline UpdateUserAttributesRequest& AddClientMetadata(Aws::String&& key, Aws::String&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(std::move(key), 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 initiates.

You create custom workflows by * assigning Lambda functions to user pool triggers. When you use the * UpdateUserAttributes 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 * UpdateUserAttributes 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.

*/ inline UpdateUserAttributesRequest& AddClientMetadata(const char* key, Aws::String&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, 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 initiates.

You create custom workflows by * assigning Lambda functions to user pool triggers. When you use the * UpdateUserAttributes 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 * UpdateUserAttributes 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.

*/ inline UpdateUserAttributesRequest& AddClientMetadata(Aws::String&& key, const char* value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(std::move(key), value); return *this; } /** *

A map of custom key-value pairs that you can provide as input for any custom * workflows that this action initiates.

You create custom workflows by * assigning Lambda functions to user pool triggers. When you use the * UpdateUserAttributes 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 * UpdateUserAttributes 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.

*/ inline UpdateUserAttributesRequest& AddClientMetadata(const char* key, const char* value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, value); return *this; } private: Aws::Vector m_userAttributes; bool m_userAttributesHasBeenSet = false; Aws::String m_accessToken; bool m_accessTokenHasBeenSet = false; Aws::Map m_clientMetadata; bool m_clientMetadataHasBeenSet = false; }; } // namespace Model } // namespace CognitoIdentityProvider } // namespace Aws