AWS SDK for C++  1.8.93
AWS SDK for C++
Public Member Functions | List of all members
Aws::DynamoDB::Model::UpdateItemRequest Class Reference

#include <UpdateItemRequest.h>

+ Inheritance diagram for Aws::DynamoDB::Model::UpdateItemRequest:

Public Member Functions

 UpdateItemRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetTableName () const
 
bool TableNameHasBeenSet () const
 
void SetTableName (const Aws::String &value)
 
void SetTableName (Aws::String &&value)
 
void SetTableName (const char *value)
 
UpdateItemRequestWithTableName (const Aws::String &value)
 
UpdateItemRequestWithTableName (Aws::String &&value)
 
UpdateItemRequestWithTableName (const char *value)
 
const Aws::Map< Aws::String, AttributeValue > & GetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::Map< Aws::String, AttributeValue > &value)
 
void SetKey (Aws::Map< Aws::String, AttributeValue > &&value)
 
UpdateItemRequestWithKey (const Aws::Map< Aws::String, AttributeValue > &value)
 
UpdateItemRequestWithKey (Aws::Map< Aws::String, AttributeValue > &&value)
 
UpdateItemRequestAddKey (const Aws::String &key, const AttributeValue &value)
 
UpdateItemRequestAddKey (Aws::String &&key, const AttributeValue &value)
 
UpdateItemRequestAddKey (const Aws::String &key, AttributeValue &&value)
 
UpdateItemRequestAddKey (Aws::String &&key, AttributeValue &&value)
 
UpdateItemRequestAddKey (const char *key, AttributeValue &&value)
 
UpdateItemRequestAddKey (const char *key, const AttributeValue &value)
 
const Aws::Map< Aws::String, AttributeValueUpdate > & GetAttributeUpdates () const
 
bool AttributeUpdatesHasBeenSet () const
 
void SetAttributeUpdates (const Aws::Map< Aws::String, AttributeValueUpdate > &value)
 
void SetAttributeUpdates (Aws::Map< Aws::String, AttributeValueUpdate > &&value)
 
UpdateItemRequestWithAttributeUpdates (const Aws::Map< Aws::String, AttributeValueUpdate > &value)
 
UpdateItemRequestWithAttributeUpdates (Aws::Map< Aws::String, AttributeValueUpdate > &&value)
 
UpdateItemRequestAddAttributeUpdates (const Aws::String &key, const AttributeValueUpdate &value)
 
UpdateItemRequestAddAttributeUpdates (Aws::String &&key, const AttributeValueUpdate &value)
 
UpdateItemRequestAddAttributeUpdates (const Aws::String &key, AttributeValueUpdate &&value)
 
UpdateItemRequestAddAttributeUpdates (Aws::String &&key, AttributeValueUpdate &&value)
 
UpdateItemRequestAddAttributeUpdates (const char *key, AttributeValueUpdate &&value)
 
UpdateItemRequestAddAttributeUpdates (const char *key, const AttributeValueUpdate &value)
 
const Aws::Map< Aws::String, ExpectedAttributeValue > & GetExpected () const
 
bool ExpectedHasBeenSet () const
 
void SetExpected (const Aws::Map< Aws::String, ExpectedAttributeValue > &value)
 
void SetExpected (Aws::Map< Aws::String, ExpectedAttributeValue > &&value)
 
UpdateItemRequestWithExpected (const Aws::Map< Aws::String, ExpectedAttributeValue > &value)
 
UpdateItemRequestWithExpected (Aws::Map< Aws::String, ExpectedAttributeValue > &&value)
 
UpdateItemRequestAddExpected (const Aws::String &key, const ExpectedAttributeValue &value)
 
UpdateItemRequestAddExpected (Aws::String &&key, const ExpectedAttributeValue &value)
 
UpdateItemRequestAddExpected (const Aws::String &key, ExpectedAttributeValue &&value)
 
UpdateItemRequestAddExpected (Aws::String &&key, ExpectedAttributeValue &&value)
 
UpdateItemRequestAddExpected (const char *key, ExpectedAttributeValue &&value)
 
UpdateItemRequestAddExpected (const char *key, const ExpectedAttributeValue &value)
 
const ConditionalOperatorGetConditionalOperator () const
 
bool ConditionalOperatorHasBeenSet () const
 
void SetConditionalOperator (const ConditionalOperator &value)
 
void SetConditionalOperator (ConditionalOperator &&value)
 
UpdateItemRequestWithConditionalOperator (const ConditionalOperator &value)
 
UpdateItemRequestWithConditionalOperator (ConditionalOperator &&value)
 
const ReturnValueGetReturnValues () const
 
bool ReturnValuesHasBeenSet () const
 
void SetReturnValues (const ReturnValue &value)
 
void SetReturnValues (ReturnValue &&value)
 
UpdateItemRequestWithReturnValues (const ReturnValue &value)
 
UpdateItemRequestWithReturnValues (ReturnValue &&value)
 
const ReturnConsumedCapacityGetReturnConsumedCapacity () const
 
bool ReturnConsumedCapacityHasBeenSet () const
 
void SetReturnConsumedCapacity (const ReturnConsumedCapacity &value)
 
void SetReturnConsumedCapacity (ReturnConsumedCapacity &&value)
 
UpdateItemRequestWithReturnConsumedCapacity (const ReturnConsumedCapacity &value)
 
UpdateItemRequestWithReturnConsumedCapacity (ReturnConsumedCapacity &&value)
 
const ReturnItemCollectionMetricsGetReturnItemCollectionMetrics () const
 
bool ReturnItemCollectionMetricsHasBeenSet () const
 
void SetReturnItemCollectionMetrics (const ReturnItemCollectionMetrics &value)
 
void SetReturnItemCollectionMetrics (ReturnItemCollectionMetrics &&value)
 
UpdateItemRequestWithReturnItemCollectionMetrics (const ReturnItemCollectionMetrics &value)
 
UpdateItemRequestWithReturnItemCollectionMetrics (ReturnItemCollectionMetrics &&value)
 
const Aws::StringGetUpdateExpression () const
 
bool UpdateExpressionHasBeenSet () const
 
void SetUpdateExpression (const Aws::String &value)
 
void SetUpdateExpression (Aws::String &&value)
 
void SetUpdateExpression (const char *value)
 
UpdateItemRequestWithUpdateExpression (const Aws::String &value)
 
UpdateItemRequestWithUpdateExpression (Aws::String &&value)
 
UpdateItemRequestWithUpdateExpression (const char *value)
 
const Aws::StringGetConditionExpression () const
 
bool ConditionExpressionHasBeenSet () const
 
void SetConditionExpression (const Aws::String &value)
 
void SetConditionExpression (Aws::String &&value)
 
void SetConditionExpression (const char *value)
 
UpdateItemRequestWithConditionExpression (const Aws::String &value)
 
UpdateItemRequestWithConditionExpression (Aws::String &&value)
 
UpdateItemRequestWithConditionExpression (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetExpressionAttributeNames () const
 
bool ExpressionAttributeNamesHasBeenSet () const
 
void SetExpressionAttributeNames (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetExpressionAttributeNames (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateItemRequestWithExpressionAttributeNames (const Aws::Map< Aws::String, Aws::String > &value)
 
UpdateItemRequestWithExpressionAttributeNames (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateItemRequestAddExpressionAttributeNames (const Aws::String &key, const Aws::String &value)
 
UpdateItemRequestAddExpressionAttributeNames (Aws::String &&key, const Aws::String &value)
 
UpdateItemRequestAddExpressionAttributeNames (const Aws::String &key, Aws::String &&value)
 
UpdateItemRequestAddExpressionAttributeNames (Aws::String &&key, Aws::String &&value)
 
UpdateItemRequestAddExpressionAttributeNames (const char *key, Aws::String &&value)
 
UpdateItemRequestAddExpressionAttributeNames (Aws::String &&key, const char *value)
 
UpdateItemRequestAddExpressionAttributeNames (const char *key, const char *value)
 
const Aws::Map< Aws::String, AttributeValue > & GetExpressionAttributeValues () const
 
bool ExpressionAttributeValuesHasBeenSet () const
 
void SetExpressionAttributeValues (const Aws::Map< Aws::String, AttributeValue > &value)
 
void SetExpressionAttributeValues (Aws::Map< Aws::String, AttributeValue > &&value)
 
UpdateItemRequestWithExpressionAttributeValues (const Aws::Map< Aws::String, AttributeValue > &value)
 
UpdateItemRequestWithExpressionAttributeValues (Aws::Map< Aws::String, AttributeValue > &&value)
 
UpdateItemRequestAddExpressionAttributeValues (const Aws::String &key, const AttributeValue &value)
 
UpdateItemRequestAddExpressionAttributeValues (Aws::String &&key, const AttributeValue &value)
 
UpdateItemRequestAddExpressionAttributeValues (const Aws::String &key, AttributeValue &&value)
 
UpdateItemRequestAddExpressionAttributeValues (Aws::String &&key, AttributeValue &&value)
 
UpdateItemRequestAddExpressionAttributeValues (const char *key, AttributeValue &&value)
 
UpdateItemRequestAddExpressionAttributeValues (const char *key, const AttributeValue &value)
 
- Public Member Functions inherited from Aws::DynamoDB::DynamoDBRequest
virtual ~DynamoDBRequest ()
 
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 input of an UpdateItem operation.

See Also:

AWS API Reference

Definition at line 33 of file UpdateItemRequest.h.

Constructor & Destructor Documentation

◆ UpdateItemRequest()

Aws::DynamoDB::Model::UpdateItemRequest::UpdateItemRequest ( )

Member Function Documentation

◆ AddAttributeUpdates() [1/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddAttributeUpdates ( const Aws::String key,
const AttributeValueUpdate value 
)
inline

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

Definition at line 253 of file UpdateItemRequest.h.

◆ AddAttributeUpdates() [2/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddAttributeUpdates ( Aws::String &&  key,
const AttributeValueUpdate value 
)
inline

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

Definition at line 261 of file UpdateItemRequest.h.

◆ AddAttributeUpdates() [3/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddAttributeUpdates ( const Aws::String key,
AttributeValueUpdate &&  value 
)
inline

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

Definition at line 269 of file UpdateItemRequest.h.

◆ AddAttributeUpdates() [4/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddAttributeUpdates ( Aws::String &&  key,
AttributeValueUpdate &&  value 
)
inline

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

Definition at line 277 of file UpdateItemRequest.h.

◆ AddAttributeUpdates() [5/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddAttributeUpdates ( const char *  key,
AttributeValueUpdate &&  value 
)
inline

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

Definition at line 285 of file UpdateItemRequest.h.

◆ AddAttributeUpdates() [6/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddAttributeUpdates ( const char *  key,
const AttributeValueUpdate value 
)
inline

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

Definition at line 293 of file UpdateItemRequest.h.

◆ AddExpected() [1/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpected ( const Aws::String key,
const ExpectedAttributeValue value 
)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Definition at line 350 of file UpdateItemRequest.h.

◆ AddExpected() [2/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpected ( Aws::String &&  key,
const ExpectedAttributeValue value 
)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Definition at line 358 of file UpdateItemRequest.h.

◆ AddExpected() [3/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpected ( const Aws::String key,
ExpectedAttributeValue &&  value 
)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Definition at line 366 of file UpdateItemRequest.h.

◆ AddExpected() [4/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpected ( Aws::String &&  key,
ExpectedAttributeValue &&  value 
)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Definition at line 374 of file UpdateItemRequest.h.

◆ AddExpected() [5/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpected ( const char *  key,
ExpectedAttributeValue &&  value 
)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Definition at line 382 of file UpdateItemRequest.h.

◆ AddExpected() [6/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpected ( const char *  key,
const ExpectedAttributeValue value 
)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Definition at line 390 of file UpdateItemRequest.h.

◆ AddExpressionAttributeNames() [1/7]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpressionAttributeNames ( const Aws::String key,
const Aws::String value 
)
inline

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1428 of file UpdateItemRequest.h.

◆ AddExpressionAttributeNames() [2/7]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpressionAttributeNames ( Aws::String &&  key,
const Aws::String value 
)
inline

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1455 of file UpdateItemRequest.h.

◆ AddExpressionAttributeNames() [3/7]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpressionAttributeNames ( const Aws::String key,
Aws::String &&  value 
)
inline

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1482 of file UpdateItemRequest.h.

◆ AddExpressionAttributeNames() [4/7]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpressionAttributeNames ( Aws::String &&  key,
Aws::String &&  value 
)
inline

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1509 of file UpdateItemRequest.h.

◆ AddExpressionAttributeNames() [5/7]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpressionAttributeNames ( const char *  key,
Aws::String &&  value 
)
inline

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1536 of file UpdateItemRequest.h.

◆ AddExpressionAttributeNames() [6/7]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpressionAttributeNames ( Aws::String &&  key,
const char *  value 
)
inline

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1563 of file UpdateItemRequest.h.

◆ AddExpressionAttributeNames() [7/7]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpressionAttributeNames ( const char *  key,
const char *  value 
)
inline

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1590 of file UpdateItemRequest.h.

◆ AddExpressionAttributeValues() [1/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpressionAttributeValues ( const Aws::String key,
const AttributeValue value 
)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1710 of file UpdateItemRequest.h.

◆ AddExpressionAttributeValues() [2/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpressionAttributeValues ( Aws::String &&  key,
const AttributeValue value 
)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1727 of file UpdateItemRequest.h.

◆ AddExpressionAttributeValues() [3/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpressionAttributeValues ( const Aws::String key,
AttributeValue &&  value 
)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1744 of file UpdateItemRequest.h.

◆ AddExpressionAttributeValues() [4/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpressionAttributeValues ( Aws::String &&  key,
AttributeValue &&  value 
)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1761 of file UpdateItemRequest.h.

◆ AddExpressionAttributeValues() [5/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpressionAttributeValues ( const char *  key,
AttributeValue &&  value 
)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1778 of file UpdateItemRequest.h.

◆ AddExpressionAttributeValues() [6/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddExpressionAttributeValues ( const char *  key,
const AttributeValue value 
)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1795 of file UpdateItemRequest.h.

◆ AddKey() [1/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddKey ( const Aws::String key,
const AttributeValue value 
)
inline

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Definition at line 151 of file UpdateItemRequest.h.

◆ AddKey() [2/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddKey ( Aws::String &&  key,
const AttributeValue value 
)
inline

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Definition at line 160 of file UpdateItemRequest.h.

◆ AddKey() [3/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddKey ( const Aws::String key,
AttributeValue &&  value 
)
inline

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Definition at line 169 of file UpdateItemRequest.h.

◆ AddKey() [4/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddKey ( Aws::String &&  key,
AttributeValue &&  value 
)
inline

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Definition at line 178 of file UpdateItemRequest.h.

◆ AddKey() [5/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddKey ( const char *  key,
AttributeValue &&  value 
)
inline

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Definition at line 187 of file UpdateItemRequest.h.

◆ AddKey() [6/6]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::AddKey ( const char *  key,
const AttributeValue value 
)
inline

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Definition at line 196 of file UpdateItemRequest.h.

◆ AttributeUpdatesHasBeenSet()

bool Aws::DynamoDB::Model::UpdateItemRequest::AttributeUpdatesHasBeenSet ( ) const
inline

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

Definition at line 213 of file UpdateItemRequest.h.

◆ ConditionalOperatorHasBeenSet()

bool Aws::DynamoDB::Model::UpdateItemRequest::ConditionalOperatorHasBeenSet ( ) const
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Definition at line 407 of file UpdateItemRequest.h.

◆ ConditionExpressionHasBeenSet()

bool Aws::DynamoDB::Model::UpdateItemRequest::ConditionExpressionHasBeenSet ( ) const
inline

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Definition at line 1154 of file UpdateItemRequest.h.

◆ ExpectedHasBeenSet()

bool Aws::DynamoDB::Model::UpdateItemRequest::ExpectedHasBeenSet ( ) const
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Definition at line 310 of file UpdateItemRequest.h.

◆ ExpressionAttributeNamesHasBeenSet()

bool Aws::DynamoDB::Model::UpdateItemRequest::ExpressionAttributeNamesHasBeenSet ( ) const
inline

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1293 of file UpdateItemRequest.h.

◆ ExpressionAttributeValuesHasBeenSet()

bool Aws::DynamoDB::Model::UpdateItemRequest::ExpressionAttributeValuesHasBeenSet ( ) const
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1625 of file UpdateItemRequest.h.

◆ GetAttributeUpdates()

const Aws::Map<Aws::String, AttributeValueUpdate>& Aws::DynamoDB::Model::UpdateItemRequest::GetAttributeUpdates ( ) const
inline

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

Definition at line 205 of file UpdateItemRequest.h.

◆ GetConditionalOperator()

const ConditionalOperator& Aws::DynamoDB::Model::UpdateItemRequest::GetConditionalOperator ( ) const
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Definition at line 399 of file UpdateItemRequest.h.

◆ GetConditionExpression()

const Aws::String& Aws::DynamoDB::Model::UpdateItemRequest::GetConditionExpression ( ) const
inline

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Definition at line 1140 of file UpdateItemRequest.h.

◆ GetExpected()

const Aws::Map<Aws::String, ExpectedAttributeValue>& Aws::DynamoDB::Model::UpdateItemRequest::GetExpected ( ) const
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Definition at line 302 of file UpdateItemRequest.h.

◆ GetExpressionAttributeNames()

const Aws::Map<Aws::String, Aws::String>& Aws::DynamoDB::Model::UpdateItemRequest::GetExpressionAttributeNames ( ) const
inline

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1266 of file UpdateItemRequest.h.

◆ GetExpressionAttributeValues()

const Aws::Map<Aws::String, AttributeValue>& Aws::DynamoDB::Model::UpdateItemRequest::GetExpressionAttributeValues ( ) const
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1608 of file UpdateItemRequest.h.

◆ GetKey()

const Aws::Map<Aws::String, AttributeValue>& Aws::DynamoDB::Model::UpdateItemRequest::GetKey ( ) const
inline

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Definition at line 97 of file UpdateItemRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DynamoDB::Model::UpdateItemRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::DynamoDB::DynamoDBRequest.

◆ GetReturnConsumedCapacity()

const ReturnConsumedCapacity& Aws::DynamoDB::Model::UpdateItemRequest::GetReturnConsumedCapacity ( ) const
inline

Definition at line 564 of file UpdateItemRequest.h.

◆ GetReturnItemCollectionMetrics()

const ReturnItemCollectionMetrics& Aws::DynamoDB::Model::UpdateItemRequest::GetReturnItemCollectionMetrics ( ) const
inline

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Definition at line 588 of file UpdateItemRequest.h.

◆ GetReturnValues()

const ReturnValue& Aws::DynamoDB::Model::UpdateItemRequest::GetReturnValues ( ) const
inline

Use ReturnValues if you want to get the item attributes as they appear before or after they are updated. For UpdateItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.

  • UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.

  • ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.

  • UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The values returned are strongly consistent.

Definition at line 460 of file UpdateItemRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::DynamoDB::Model::UpdateItemRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 42 of file UpdateItemRequest.h.

◆ GetTableName()

const Aws::String& Aws::DynamoDB::Model::UpdateItemRequest::GetTableName ( ) const
inline

The name of the table containing the item to update.

Definition at line 52 of file UpdateItemRequest.h.

◆ GetUpdateExpression()

const Aws::String& Aws::DynamoDB::Model::UpdateItemRequest::GetUpdateExpression ( ) const
inline

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

The following action values are available for UpdateExpression.

  • SET - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

    SET supports the following functions:

    • if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

    • list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

    These function names are case-sensitive.

  • REMOVE - Removes one or more attributes from an item.

  • ADD

    • Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
    • If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.

    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.

  • DELETE - Deletes an element from a set.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

    The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 691 of file UpdateItemRequest.h.

◆ KeyHasBeenSet()

bool Aws::DynamoDB::Model::UpdateItemRequest::KeyHasBeenSet ( ) const
inline

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Definition at line 106 of file UpdateItemRequest.h.

◆ ReturnConsumedCapacityHasBeenSet()

bool Aws::DynamoDB::Model::UpdateItemRequest::ReturnConsumedCapacityHasBeenSet ( ) const
inline

Definition at line 567 of file UpdateItemRequest.h.

◆ ReturnItemCollectionMetricsHasBeenSet()

bool Aws::DynamoDB::Model::UpdateItemRequest::ReturnItemCollectionMetricsHasBeenSet ( ) const
inline

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Definition at line 596 of file UpdateItemRequest.h.

◆ ReturnValuesHasBeenSet()

bool Aws::DynamoDB::Model::UpdateItemRequest::ReturnValuesHasBeenSet ( ) const
inline

Use ReturnValues if you want to get the item attributes as they appear before or after they are updated. For UpdateItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.

  • UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.

  • ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.

  • UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The values returned are strongly consistent.

Definition at line 480 of file UpdateItemRequest.h.

◆ SerializePayload()

Aws::String Aws::DynamoDB::Model::UpdateItemRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttributeUpdates() [1/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetAttributeUpdates ( const Aws::Map< Aws::String, AttributeValueUpdate > &  value)
inline

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

Definition at line 221 of file UpdateItemRequest.h.

◆ SetAttributeUpdates() [2/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetAttributeUpdates ( Aws::Map< Aws::String, AttributeValueUpdate > &&  value)
inline

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

Definition at line 229 of file UpdateItemRequest.h.

◆ SetConditionalOperator() [1/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetConditionalOperator ( const ConditionalOperator value)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Definition at line 415 of file UpdateItemRequest.h.

◆ SetConditionalOperator() [2/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetConditionalOperator ( ConditionalOperator &&  value)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Definition at line 423 of file UpdateItemRequest.h.

◆ SetConditionExpression() [1/3]

void Aws::DynamoDB::Model::UpdateItemRequest::SetConditionExpression ( const Aws::String value)
inline

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Definition at line 1168 of file UpdateItemRequest.h.

◆ SetConditionExpression() [2/3]

void Aws::DynamoDB::Model::UpdateItemRequest::SetConditionExpression ( Aws::String &&  value)
inline

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Definition at line 1182 of file UpdateItemRequest.h.

◆ SetConditionExpression() [3/3]

void Aws::DynamoDB::Model::UpdateItemRequest::SetConditionExpression ( const char *  value)
inline

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Definition at line 1196 of file UpdateItemRequest.h.

◆ SetExpected() [1/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetExpected ( const Aws::Map< Aws::String, ExpectedAttributeValue > &  value)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Definition at line 318 of file UpdateItemRequest.h.

◆ SetExpected() [2/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetExpected ( Aws::Map< Aws::String, ExpectedAttributeValue > &&  value)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Definition at line 326 of file UpdateItemRequest.h.

◆ SetExpressionAttributeNames() [1/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetExpressionAttributeNames ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1320 of file UpdateItemRequest.h.

◆ SetExpressionAttributeNames() [2/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetExpressionAttributeNames ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1347 of file UpdateItemRequest.h.

◆ SetExpressionAttributeValues() [1/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetExpressionAttributeValues ( const Aws::Map< Aws::String, AttributeValue > &  value)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1642 of file UpdateItemRequest.h.

◆ SetExpressionAttributeValues() [2/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetExpressionAttributeValues ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1659 of file UpdateItemRequest.h.

◆ SetKey() [1/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetKey ( const Aws::Map< Aws::String, AttributeValue > &  value)
inline

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Definition at line 115 of file UpdateItemRequest.h.

◆ SetKey() [2/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetKey ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Definition at line 124 of file UpdateItemRequest.h.

◆ SetReturnConsumedCapacity() [1/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetReturnConsumedCapacity ( const ReturnConsumedCapacity value)
inline

Definition at line 570 of file UpdateItemRequest.h.

◆ SetReturnConsumedCapacity() [2/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetReturnConsumedCapacity ( ReturnConsumedCapacity &&  value)
inline

Definition at line 573 of file UpdateItemRequest.h.

◆ SetReturnItemCollectionMetrics() [1/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetReturnItemCollectionMetrics ( const ReturnItemCollectionMetrics value)
inline

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Definition at line 604 of file UpdateItemRequest.h.

◆ SetReturnItemCollectionMetrics() [2/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetReturnItemCollectionMetrics ( ReturnItemCollectionMetrics &&  value)
inline

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Definition at line 612 of file UpdateItemRequest.h.

◆ SetReturnValues() [1/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetReturnValues ( const ReturnValue value)
inline

Use ReturnValues if you want to get the item attributes as they appear before or after they are updated. For UpdateItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.

  • UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.

  • ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.

  • UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The values returned are strongly consistent.

Definition at line 500 of file UpdateItemRequest.h.

◆ SetReturnValues() [2/2]

void Aws::DynamoDB::Model::UpdateItemRequest::SetReturnValues ( ReturnValue &&  value)
inline

Use ReturnValues if you want to get the item attributes as they appear before or after they are updated. For UpdateItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.

  • UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.

  • ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.

  • UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The values returned are strongly consistent.

Definition at line 520 of file UpdateItemRequest.h.

◆ SetTableName() [1/3]

void Aws::DynamoDB::Model::UpdateItemRequest::SetTableName ( const Aws::String value)
inline

The name of the table containing the item to update.

Definition at line 62 of file UpdateItemRequest.h.

◆ SetTableName() [2/3]

void Aws::DynamoDB::Model::UpdateItemRequest::SetTableName ( Aws::String &&  value)
inline

The name of the table containing the item to update.

Definition at line 67 of file UpdateItemRequest.h.

◆ SetTableName() [3/3]

void Aws::DynamoDB::Model::UpdateItemRequest::SetTableName ( const char *  value)
inline

The name of the table containing the item to update.

Definition at line 72 of file UpdateItemRequest.h.

◆ SetUpdateExpression() [1/3]

void Aws::DynamoDB::Model::UpdateItemRequest::SetUpdateExpression ( const Aws::String value)
inline

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

The following action values are available for UpdateExpression.

  • SET - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

    SET supports the following functions:

    • if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

    • list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

    These function names are case-sensitive.

  • REMOVE - Removes one or more attributes from an item.

  • ADD

    • Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
    • If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.

    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.

  • DELETE - Deletes an element from a set.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

    The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 815 of file UpdateItemRequest.h.

◆ SetUpdateExpression() [2/3]

void Aws::DynamoDB::Model::UpdateItemRequest::SetUpdateExpression ( Aws::String &&  value)
inline

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

The following action values are available for UpdateExpression.

  • SET - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

    SET supports the following functions:

    • if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

    • list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

    These function names are case-sensitive.

  • REMOVE - Removes one or more attributes from an item.

  • ADD

    • Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
    • If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.

    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.

  • DELETE - Deletes an element from a set.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

    The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 877 of file UpdateItemRequest.h.

◆ SetUpdateExpression() [3/3]

void Aws::DynamoDB::Model::UpdateItemRequest::SetUpdateExpression ( const char *  value)
inline

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

The following action values are available for UpdateExpression.

  • SET - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

    SET supports the following functions:

    • if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

    • list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

    These function names are case-sensitive.

  • REMOVE - Removes one or more attributes from an item.

  • ADD

    • Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
    • If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.

    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.

  • DELETE - Deletes an element from a set.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

    The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 939 of file UpdateItemRequest.h.

◆ TableNameHasBeenSet()

bool Aws::DynamoDB::Model::UpdateItemRequest::TableNameHasBeenSet ( ) const
inline

The name of the table containing the item to update.

Definition at line 57 of file UpdateItemRequest.h.

◆ UpdateExpressionHasBeenSet()

bool Aws::DynamoDB::Model::UpdateItemRequest::UpdateExpressionHasBeenSet ( ) const
inline

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

The following action values are available for UpdateExpression.

  • SET - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

    SET supports the following functions:

    • if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

    • list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

    These function names are case-sensitive.

  • REMOVE - Removes one or more attributes from an item.

  • ADD

    • Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
    • If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.

    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.

  • DELETE - Deletes an element from a set.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

    The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 753 of file UpdateItemRequest.h.

◆ WithAttributeUpdates() [1/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithAttributeUpdates ( const Aws::Map< Aws::String, AttributeValueUpdate > &  value)
inline

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

Definition at line 237 of file UpdateItemRequest.h.

◆ WithAttributeUpdates() [2/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithAttributeUpdates ( Aws::Map< Aws::String, AttributeValueUpdate > &&  value)
inline

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

Definition at line 245 of file UpdateItemRequest.h.

◆ WithConditionalOperator() [1/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithConditionalOperator ( const ConditionalOperator value)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Definition at line 431 of file UpdateItemRequest.h.

◆ WithConditionalOperator() [2/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithConditionalOperator ( ConditionalOperator &&  value)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Definition at line 439 of file UpdateItemRequest.h.

◆ WithConditionExpression() [1/3]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithConditionExpression ( const Aws::String value)
inline

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Definition at line 1210 of file UpdateItemRequest.h.

◆ WithConditionExpression() [2/3]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithConditionExpression ( Aws::String &&  value)
inline

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Definition at line 1224 of file UpdateItemRequest.h.

◆ WithConditionExpression() [3/3]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithConditionExpression ( const char *  value)
inline

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

Definition at line 1238 of file UpdateItemRequest.h.

◆ WithExpected() [1/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithExpected ( const Aws::Map< Aws::String, ExpectedAttributeValue > &  value)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Definition at line 334 of file UpdateItemRequest.h.

◆ WithExpected() [2/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithExpected ( Aws::Map< Aws::String, ExpectedAttributeValue > &&  value)
inline

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Definition at line 342 of file UpdateItemRequest.h.

◆ WithExpressionAttributeNames() [1/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithExpressionAttributeNames ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1374 of file UpdateItemRequest.h.

◆ WithExpressionAttributeNames() [2/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithExpressionAttributeNames ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1401 of file UpdateItemRequest.h.

◆ WithExpressionAttributeValues() [1/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithExpressionAttributeValues ( const Aws::Map< Aws::String, AttributeValue > &  value)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1676 of file UpdateItemRequest.h.

◆ WithExpressionAttributeValues() [2/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithExpressionAttributeValues ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1693 of file UpdateItemRequest.h.

◆ WithKey() [1/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithKey ( const Aws::Map< Aws::String, AttributeValue > &  value)
inline

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Definition at line 133 of file UpdateItemRequest.h.

◆ WithKey() [2/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithKey ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Definition at line 142 of file UpdateItemRequest.h.

◆ WithReturnConsumedCapacity() [1/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithReturnConsumedCapacity ( const ReturnConsumedCapacity value)
inline

Definition at line 576 of file UpdateItemRequest.h.

◆ WithReturnConsumedCapacity() [2/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithReturnConsumedCapacity ( ReturnConsumedCapacity &&  value)
inline

Definition at line 579 of file UpdateItemRequest.h.

◆ WithReturnItemCollectionMetrics() [1/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithReturnItemCollectionMetrics ( const ReturnItemCollectionMetrics value)
inline

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Definition at line 620 of file UpdateItemRequest.h.

◆ WithReturnItemCollectionMetrics() [2/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithReturnItemCollectionMetrics ( ReturnItemCollectionMetrics &&  value)
inline

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Definition at line 628 of file UpdateItemRequest.h.

◆ WithReturnValues() [1/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithReturnValues ( const ReturnValue value)
inline

Use ReturnValues if you want to get the item attributes as they appear before or after they are updated. For UpdateItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.

  • UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.

  • ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.

  • UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The values returned are strongly consistent.

Definition at line 540 of file UpdateItemRequest.h.

◆ WithReturnValues() [2/2]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithReturnValues ( ReturnValue &&  value)
inline

Use ReturnValues if you want to get the item attributes as they appear before or after they are updated. For UpdateItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.

  • UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.

  • ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.

  • UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The values returned are strongly consistent.

Definition at line 560 of file UpdateItemRequest.h.

◆ WithTableName() [1/3]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithTableName ( const Aws::String value)
inline

The name of the table containing the item to update.

Definition at line 77 of file UpdateItemRequest.h.

◆ WithTableName() [2/3]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithTableName ( Aws::String &&  value)
inline

The name of the table containing the item to update.

Definition at line 82 of file UpdateItemRequest.h.

◆ WithTableName() [3/3]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithTableName ( const char *  value)
inline

The name of the table containing the item to update.

Definition at line 87 of file UpdateItemRequest.h.

◆ WithUpdateExpression() [1/3]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithUpdateExpression ( const Aws::String value)
inline

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

The following action values are available for UpdateExpression.

  • SET - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

    SET supports the following functions:

    • if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

    • list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

    These function names are case-sensitive.

  • REMOVE - Removes one or more attributes from an item.

  • ADD

    • Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
    • If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.

    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.

  • DELETE - Deletes an element from a set.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

    The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1001 of file UpdateItemRequest.h.

◆ WithUpdateExpression() [2/3]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithUpdateExpression ( Aws::String &&  value)
inline

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

The following action values are available for UpdateExpression.

  • SET - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

    SET supports the following functions:

    • if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

    • list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

    These function names are case-sensitive.

  • REMOVE - Removes one or more attributes from an item.

  • ADD

    • Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
    • If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.

    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.

  • DELETE - Deletes an element from a set.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

    The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1063 of file UpdateItemRequest.h.

◆ WithUpdateExpression() [3/3]

UpdateItemRequest& Aws::DynamoDB::Model::UpdateItemRequest::WithUpdateExpression ( const char *  value)
inline

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

The following action values are available for UpdateExpression.

  • SET - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

    SET supports the following functions:

    • if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

    • list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

    These function names are case-sensitive.

  • REMOVE - Removes one or more attributes from an item.

  • ADD

    • Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
    • If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.

    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.

  • DELETE - Deletes an element from a set.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

    The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 1125 of file UpdateItemRequest.h.


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