AWS SDK for C++  1.8.54
AWS SDK for C++
Public Member Functions | List of all members
Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest Class Reference

#include <AdminUpdateUserAttributesRequest.h>

+ Inheritance diagram for Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest:

Public Member Functions

 AdminUpdateUserAttributesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetUserPoolId () const
 
bool UserPoolIdHasBeenSet () const
 
void SetUserPoolId (const Aws::String &value)
 
void SetUserPoolId (Aws::String &&value)
 
void SetUserPoolId (const char *value)
 
AdminUpdateUserAttributesRequestWithUserPoolId (const Aws::String &value)
 
AdminUpdateUserAttributesRequestWithUserPoolId (Aws::String &&value)
 
AdminUpdateUserAttributesRequestWithUserPoolId (const char *value)
 
const Aws::StringGetUsername () const
 
bool UsernameHasBeenSet () const
 
void SetUsername (const Aws::String &value)
 
void SetUsername (Aws::String &&value)
 
void SetUsername (const char *value)
 
AdminUpdateUserAttributesRequestWithUsername (const Aws::String &value)
 
AdminUpdateUserAttributesRequestWithUsername (Aws::String &&value)
 
AdminUpdateUserAttributesRequestWithUsername (const char *value)
 
const Aws::Vector< AttributeType > & GetUserAttributes () const
 
bool UserAttributesHasBeenSet () const
 
void SetUserAttributes (const Aws::Vector< AttributeType > &value)
 
void SetUserAttributes (Aws::Vector< AttributeType > &&value)
 
AdminUpdateUserAttributesRequestWithUserAttributes (const Aws::Vector< AttributeType > &value)
 
AdminUpdateUserAttributesRequestWithUserAttributes (Aws::Vector< AttributeType > &&value)
 
AdminUpdateUserAttributesRequestAddUserAttributes (const AttributeType &value)
 
AdminUpdateUserAttributesRequestAddUserAttributes (AttributeType &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetClientMetadata () const
 
bool ClientMetadataHasBeenSet () const
 
void SetClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
AdminUpdateUserAttributesRequestWithClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
AdminUpdateUserAttributesRequestWithClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
AdminUpdateUserAttributesRequestAddClientMetadata (const Aws::String &key, const Aws::String &value)
 
AdminUpdateUserAttributesRequestAddClientMetadata (Aws::String &&key, const Aws::String &value)
 
AdminUpdateUserAttributesRequestAddClientMetadata (const Aws::String &key, Aws::String &&value)
 
AdminUpdateUserAttributesRequestAddClientMetadata (Aws::String &&key, Aws::String &&value)
 
AdminUpdateUserAttributesRequestAddClientMetadata (const char *key, Aws::String &&value)
 
AdminUpdateUserAttributesRequestAddClientMetadata (Aws::String &&key, const char *value)
 
AdminUpdateUserAttributesRequestAddClientMetadata (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest
virtual ~CognitoIdentityProviderRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 28 of file AdminUpdateUserAttributesRequest.h.

Constructor & Destructor Documentation

◆ AdminUpdateUserAttributesRequest()

Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::AdminUpdateUserAttributesRequest ( )

Member Function Documentation

◆ AddClientMetadata() [1/7]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::AddClientMetadata ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 371 of file AdminUpdateUserAttributesRequest.h.

◆ AddClientMetadata() [2/7]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::AddClientMetadata ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 397 of file AdminUpdateUserAttributesRequest.h.

◆ AddClientMetadata() [3/7]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::AddClientMetadata ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 423 of file AdminUpdateUserAttributesRequest.h.

◆ AddClientMetadata() [4/7]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::AddClientMetadata ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 449 of file AdminUpdateUserAttributesRequest.h.

◆ AddClientMetadata() [5/7]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::AddClientMetadata ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 475 of file AdminUpdateUserAttributesRequest.h.

◆ AddClientMetadata() [6/7]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::AddClientMetadata ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 501 of file AdminUpdateUserAttributesRequest.h.

◆ AddClientMetadata() [7/7]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::AddClientMetadata ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 527 of file AdminUpdateUserAttributesRequest.h.

◆ AddUserAttributes() [1/2]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::AddUserAttributes ( const AttributeType value)
inline

An array of name-value pairs representing user attributes.

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

Definition at line 181 of file AdminUpdateUserAttributesRequest.h.

◆ AddUserAttributes() [2/2]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::AddUserAttributes ( AttributeType &&  value)
inline

An array of name-value pairs representing user attributes.

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

Definition at line 188 of file AdminUpdateUserAttributesRequest.h.

◆ ClientMetadataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::ClientMetadataHasBeenSet ( ) const
inline

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.

Definition at line 241 of file AdminUpdateUserAttributesRequest.h.

◆ GetClientMetadata()

const Aws::Map<Aws::String, Aws::String>& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::GetClientMetadata ( ) const
inline

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.

Definition at line 215 of file AdminUpdateUserAttributesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file AdminUpdateUserAttributesRequest.h.

◆ GetUserAttributes()

const Aws::Vector<AttributeType>& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::GetUserAttributes ( ) const
inline

An array of name-value pairs representing user attributes.

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

Definition at line 139 of file AdminUpdateUserAttributesRequest.h.

◆ GetUsername()

const Aws::String& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::GetUsername ( ) const
inline

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

Definition at line 96 of file AdminUpdateUserAttributesRequest.h.

◆ GetUserPoolId()

const Aws::String& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::GetUserPoolId ( ) const
inline

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

Definition at line 48 of file AdminUpdateUserAttributesRequest.h.

◆ SerializePayload()

Aws::String Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientMetadata() [1/2]

void Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::SetClientMetadata ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 267 of file AdminUpdateUserAttributesRequest.h.

◆ SetClientMetadata() [2/2]

void Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::SetClientMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 293 of file AdminUpdateUserAttributesRequest.h.

◆ SetUserAttributes() [1/2]

void Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::SetUserAttributes ( const Aws::Vector< AttributeType > &  value)
inline

An array of name-value pairs representing user attributes.

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

Definition at line 153 of file AdminUpdateUserAttributesRequest.h.

◆ SetUserAttributes() [2/2]

void Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::SetUserAttributes ( Aws::Vector< AttributeType > &&  value)
inline

An array of name-value pairs representing user attributes.

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

Definition at line 160 of file AdminUpdateUserAttributesRequest.h.

◆ SetUsername() [1/3]

void Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::SetUsername ( const Aws::String value)
inline

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

Definition at line 106 of file AdminUpdateUserAttributesRequest.h.

◆ SetUsername() [2/3]

void Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::SetUsername ( Aws::String &&  value)
inline

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

Definition at line 111 of file AdminUpdateUserAttributesRequest.h.

◆ SetUsername() [3/3]

void Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::SetUsername ( const char *  value)
inline

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

Definition at line 116 of file AdminUpdateUserAttributesRequest.h.

◆ SetUserPoolId() [1/3]

void Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::SetUserPoolId ( const Aws::String value)
inline

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

Definition at line 60 of file AdminUpdateUserAttributesRequest.h.

◆ SetUserPoolId() [2/3]

void Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::SetUserPoolId ( Aws::String &&  value)
inline

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

Definition at line 66 of file AdminUpdateUserAttributesRequest.h.

◆ SetUserPoolId() [3/3]

void Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::SetUserPoolId ( const char *  value)
inline

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

Definition at line 72 of file AdminUpdateUserAttributesRequest.h.

◆ UserAttributesHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::UserAttributesHasBeenSet ( ) const
inline

An array of name-value pairs representing user attributes.

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

Definition at line 146 of file AdminUpdateUserAttributesRequest.h.

◆ UsernameHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::UsernameHasBeenSet ( ) const
inline

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

Definition at line 101 of file AdminUpdateUserAttributesRequest.h.

◆ UserPoolIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::UserPoolIdHasBeenSet ( ) const
inline

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

Definition at line 54 of file AdminUpdateUserAttributesRequest.h.

◆ WithClientMetadata() [1/2]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::WithClientMetadata ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 319 of file AdminUpdateUserAttributesRequest.h.

◆ WithClientMetadata() [2/2]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::WithClientMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 345 of file AdminUpdateUserAttributesRequest.h.

◆ WithUserAttributes() [1/2]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::WithUserAttributes ( const Aws::Vector< AttributeType > &  value)
inline

An array of name-value pairs representing user attributes.

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

Definition at line 167 of file AdminUpdateUserAttributesRequest.h.

◆ WithUserAttributes() [2/2]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::WithUserAttributes ( Aws::Vector< AttributeType > &&  value)
inline

An array of name-value pairs representing user attributes.

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

Definition at line 174 of file AdminUpdateUserAttributesRequest.h.

◆ WithUsername() [1/3]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::WithUsername ( const Aws::String value)
inline

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

Definition at line 121 of file AdminUpdateUserAttributesRequest.h.

◆ WithUsername() [2/3]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::WithUsername ( Aws::String &&  value)
inline

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

Definition at line 126 of file AdminUpdateUserAttributesRequest.h.

◆ WithUsername() [3/3]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::WithUsername ( const char *  value)
inline

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

Definition at line 131 of file AdminUpdateUserAttributesRequest.h.

◆ WithUserPoolId() [1/3]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::WithUserPoolId ( const Aws::String value)
inline

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

Definition at line 78 of file AdminUpdateUserAttributesRequest.h.

◆ WithUserPoolId() [2/3]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::WithUserPoolId ( Aws::String &&  value)
inline

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

Definition at line 84 of file AdminUpdateUserAttributesRequest.h.

◆ WithUserPoolId() [3/3]

AdminUpdateUserAttributesRequest& Aws::CognitoIdentityProvider::Model::AdminUpdateUserAttributesRequest::WithUserPoolId ( const char *  value)
inline

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

Definition at line 90 of file AdminUpdateUserAttributesRequest.h.


The documentation for this class was generated from the following file: