/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Represents the input of an UpdateItem
operation.See
* Also:
AWS
* API Reference
The name of the table containing the item to update.
*/ inline const Aws::String& GetTableName() const{ return m_tableName; } /** *The name of the table containing the item to update.
*/ inline bool TableNameHasBeenSet() const { return m_tableNameHasBeenSet; } /** *The name of the table containing the item to update.
*/ inline void SetTableName(const Aws::String& value) { m_tableNameHasBeenSet = true; m_tableName = value; } /** *The name of the table containing the item to update.
*/ inline void SetTableName(Aws::String&& value) { m_tableNameHasBeenSet = true; m_tableName = std::move(value); } /** *The name of the table containing the item to update.
*/ inline void SetTableName(const char* value) { m_tableNameHasBeenSet = true; m_tableName.assign(value); } /** *The name of the table containing the item to update.
*/ inline UpdateItemRequest& WithTableName(const Aws::String& value) { SetTableName(value); return *this;} /** *The name of the table containing the item to update.
*/ inline UpdateItemRequest& WithTableName(Aws::String&& value) { SetTableName(std::move(value)); return *this;} /** *The name of the table containing the item to update.
*/ inline UpdateItemRequest& WithTableName(const char* value) { SetTableName(value); return *this;} /** *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.
*/ inline const Aws::MapThe 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.
*/ inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; } /** *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.
*/ inline void SetKey(const Aws::MapThe 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.
*/ inline void SetKey(Aws::MapThe 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.
*/ inline UpdateItemRequest& WithKey(const Aws::MapThe 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.
*/ inline UpdateItemRequest& WithKey(Aws::MapThe 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.
*/ inline UpdateItemRequest& AddKey(const Aws::String& key, const AttributeValue& value) { m_keyHasBeenSet = true; m_key.emplace(key, value); return *this; } /** *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.
*/ inline UpdateItemRequest& AddKey(Aws::String&& key, const AttributeValue& value) { m_keyHasBeenSet = true; m_key.emplace(std::move(key), value); return *this; } /** *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.
*/ inline UpdateItemRequest& AddKey(const Aws::String& key, AttributeValue&& value) { m_keyHasBeenSet = true; m_key.emplace(key, std::move(value)); return *this; } /** *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.
*/ inline UpdateItemRequest& AddKey(Aws::String&& key, AttributeValue&& value) { m_keyHasBeenSet = true; m_key.emplace(std::move(key), std::move(value)); return *this; } /** *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.
*/ inline UpdateItemRequest& AddKey(const char* key, AttributeValue&& value) { m_keyHasBeenSet = true; m_key.emplace(key, std::move(value)); return *this; } /** *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.
*/ inline UpdateItemRequest& AddKey(const char* key, const AttributeValue& value) { m_keyHasBeenSet = true; m_key.emplace(key, value); return *this; } /** *This is a legacy parameter. Use UpdateExpression
instead. For
* more information, see AttributeUpdates
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use UpdateExpression
instead. For
* more information, see AttributeUpdates
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use UpdateExpression
instead. For
* more information, see AttributeUpdates
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use UpdateExpression
instead. For
* more information, see AttributeUpdates
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use UpdateExpression
instead. For
* more information, see AttributeUpdates
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use UpdateExpression
instead. For
* more information, see AttributeUpdates
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use UpdateExpression
instead. For
* more information, see AttributeUpdates
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use UpdateExpression
instead. For
* more information, see AttributeUpdates
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use UpdateExpression
instead. For
* more information, see AttributeUpdates
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use UpdateExpression
instead. For
* more information, see AttributeUpdates
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use UpdateExpression
instead. For
* more information, see AttributeUpdates
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use UpdateExpression
instead. For
* more information, see AttributeUpdates
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see Expected
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see Expected
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see Expected
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see Expected
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see Expected
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see Expected
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see Expected
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see Expected
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see Expected
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see Expected
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see Expected
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see Expected
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see ConditionalOperator
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see ConditionalOperator
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see ConditionalOperator
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see ConditionalOperator
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see ConditionalOperator
* in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For
* more information, see ConditionalOperator
* in the Amazon DynamoDB Developer Guide.
Use ReturnValues
if you want to get the item attributes as they
* appear before or after they are successfully 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.
*/ inline const ReturnValue& GetReturnValues() const{ return m_returnValues; } /** *Use ReturnValues
if you want to get the item attributes as they
* appear before or after they are successfully 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.
*/ inline bool ReturnValuesHasBeenSet() const { return m_returnValuesHasBeenSet; } /** *Use ReturnValues
if you want to get the item attributes as they
* appear before or after they are successfully 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.
*/ inline void SetReturnValues(const ReturnValue& value) { m_returnValuesHasBeenSet = true; m_returnValues = value; } /** *Use ReturnValues
if you want to get the item attributes as they
* appear before or after they are successfully 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.
*/ inline void SetReturnValues(ReturnValue&& value) { m_returnValuesHasBeenSet = true; m_returnValues = std::move(value); } /** *Use ReturnValues
if you want to get the item attributes as they
* appear before or after they are successfully 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.
*/ inline UpdateItemRequest& WithReturnValues(const ReturnValue& value) { SetReturnValues(value); return *this;} /** *Use ReturnValues
if you want to get the item attributes as they
* appear before or after they are successfully 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.
*/ inline UpdateItemRequest& WithReturnValues(ReturnValue&& value) { SetReturnValues(std::move(value)); return *this;} inline const ReturnConsumedCapacity& GetReturnConsumedCapacity() const{ return m_returnConsumedCapacity; } inline bool ReturnConsumedCapacityHasBeenSet() const { return m_returnConsumedCapacityHasBeenSet; } inline void SetReturnConsumedCapacity(const ReturnConsumedCapacity& value) { m_returnConsumedCapacityHasBeenSet = true; m_returnConsumedCapacity = value; } inline void SetReturnConsumedCapacity(ReturnConsumedCapacity&& value) { m_returnConsumedCapacityHasBeenSet = true; m_returnConsumedCapacity = std::move(value); } inline UpdateItemRequest& WithReturnConsumedCapacity(const ReturnConsumedCapacity& value) { SetReturnConsumedCapacity(value); return *this;} inline UpdateItemRequest& WithReturnConsumedCapacity(ReturnConsumedCapacity&& value) { SetReturnConsumedCapacity(std::move(value)); return *this;} /** *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.
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.
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.
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.
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.
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.
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.
*/ inline const Aws::String& GetUpdateExpression() const{ return m_updateExpression; } /** *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.
*/ inline bool UpdateExpressionHasBeenSet() const { return m_updateExpressionHasBeenSet; } /** *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.
*/ inline void SetUpdateExpression(const Aws::String& value) { m_updateExpressionHasBeenSet = true; m_updateExpression = value; } /** *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.
*/ inline void SetUpdateExpression(Aws::String&& value) { m_updateExpressionHasBeenSet = true; m_updateExpression = std::move(value); } /** *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.
*/ inline void SetUpdateExpression(const char* value) { m_updateExpressionHasBeenSet = true; m_updateExpression.assign(value); } /** *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.
*/ inline UpdateItemRequest& WithUpdateExpression(const Aws::String& value) { SetUpdateExpression(value); return *this;} /** *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.
*/ inline UpdateItemRequest& WithUpdateExpression(Aws::String&& value) { SetUpdateExpression(std::move(value)); return *this;} /** *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.
*/ inline UpdateItemRequest& WithUpdateExpression(const char* value) { SetUpdateExpression(value); return *this;} /** *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.
*/ inline const Aws::String& GetConditionExpression() const{ return m_conditionExpression; } /** *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.
*/ inline bool ConditionExpressionHasBeenSet() const { return m_conditionExpressionHasBeenSet; } /** *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.
*/ inline void SetConditionExpression(const Aws::String& value) { m_conditionExpressionHasBeenSet = true; m_conditionExpression = value; } /** *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.
*/ inline void SetConditionExpression(Aws::String&& value) { m_conditionExpressionHasBeenSet = true; m_conditionExpression = std::move(value); } /** *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.
*/ inline void SetConditionExpression(const char* value) { m_conditionExpressionHasBeenSet = true; m_conditionExpression.assign(value); } /** *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.
*/ inline UpdateItemRequest& WithConditionExpression(const Aws::String& value) { SetConditionExpression(value); return *this;} /** *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.
*/ inline UpdateItemRequest& WithConditionExpression(Aws::String&& value) { SetConditionExpression(std::move(value)); return *this;} /** *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.
*/ inline UpdateItemRequest& WithConditionExpression(const char* value) { SetConditionExpression(value); return *this;} /** *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.
*/ inline const Aws::MapOne 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.
*/ inline bool ExpressionAttributeNamesHasBeenSet() const { return m_expressionAttributeNamesHasBeenSet; } /** *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.
*/ inline void SetExpressionAttributeNames(const Aws::MapOne 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.
*/ inline void SetExpressionAttributeNames(Aws::MapOne 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.
*/ inline UpdateItemRequest& WithExpressionAttributeNames(const Aws::MapOne 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.
*/ inline UpdateItemRequest& WithExpressionAttributeNames(Aws::MapOne 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.
*/ inline UpdateItemRequest& AddExpressionAttributeNames(const Aws::String& key, const Aws::String& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(key, value); return *this; } /** *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.
*/ inline UpdateItemRequest& AddExpressionAttributeNames(Aws::String&& key, const Aws::String& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(std::move(key), value); return *this; } /** *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.
*/ inline UpdateItemRequest& AddExpressionAttributeNames(const Aws::String& key, Aws::String&& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(key, std::move(value)); return *this; } /** *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.
*/ inline UpdateItemRequest& AddExpressionAttributeNames(Aws::String&& key, Aws::String&& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(std::move(key), std::move(value)); return *this; } /** *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.
*/ inline UpdateItemRequest& AddExpressionAttributeNames(const char* key, Aws::String&& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(key, std::move(value)); return *this; } /** *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.
*/ inline UpdateItemRequest& AddExpressionAttributeNames(Aws::String&& key, const char* value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(std::move(key), value); return *this; } /** *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.
*/ inline UpdateItemRequest& AddExpressionAttributeNames(const char* key, const char* value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(key, value); return *this; } /** *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.
*/ inline const Aws::MapOne 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.
*/ inline bool ExpressionAttributeValuesHasBeenSet() const { return m_expressionAttributeValuesHasBeenSet; } /** *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.
*/ inline void SetExpressionAttributeValues(const Aws::MapOne 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.
*/ inline void SetExpressionAttributeValues(Aws::MapOne 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.
*/ inline UpdateItemRequest& WithExpressionAttributeValues(const Aws::MapOne 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.
*/ inline UpdateItemRequest& WithExpressionAttributeValues(Aws::MapOne 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.
*/ inline UpdateItemRequest& AddExpressionAttributeValues(const Aws::String& key, const AttributeValue& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(key, value); return *this; } /** *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.
*/ inline UpdateItemRequest& AddExpressionAttributeValues(Aws::String&& key, const AttributeValue& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(std::move(key), value); return *this; } /** *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.
*/ inline UpdateItemRequest& AddExpressionAttributeValues(const Aws::String& key, AttributeValue&& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(key, std::move(value)); return *this; } /** *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.
*/ inline UpdateItemRequest& AddExpressionAttributeValues(Aws::String&& key, AttributeValue&& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(std::move(key), std::move(value)); return *this; } /** *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.
*/ inline UpdateItemRequest& AddExpressionAttributeValues(const char* key, AttributeValue&& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(key, std::move(value)); return *this; } /** *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.
*/ inline UpdateItemRequest& AddExpressionAttributeValues(const char* key, const AttributeValue& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(key, value); return *this; } /** *An optional parameter that returns the item attributes for an
* UpdateItem
operation that failed a condition check.
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.
*/ inline const ReturnValuesOnConditionCheckFailure& GetReturnValuesOnConditionCheckFailure() const{ return m_returnValuesOnConditionCheckFailure; } /** *An optional parameter that returns the item attributes for an
* UpdateItem
operation that failed a condition check.
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.
*/ inline bool ReturnValuesOnConditionCheckFailureHasBeenSet() const { return m_returnValuesOnConditionCheckFailureHasBeenSet; } /** *An optional parameter that returns the item attributes for an
* UpdateItem
operation that failed a condition check.
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.
*/ inline void SetReturnValuesOnConditionCheckFailure(const ReturnValuesOnConditionCheckFailure& value) { m_returnValuesOnConditionCheckFailureHasBeenSet = true; m_returnValuesOnConditionCheckFailure = value; } /** *An optional parameter that returns the item attributes for an
* UpdateItem
operation that failed a condition check.
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.
*/ inline void SetReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure&& value) { m_returnValuesOnConditionCheckFailureHasBeenSet = true; m_returnValuesOnConditionCheckFailure = std::move(value); } /** *An optional parameter that returns the item attributes for an
* UpdateItem
operation that failed a condition check.
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.
*/ inline UpdateItemRequest& WithReturnValuesOnConditionCheckFailure(const ReturnValuesOnConditionCheckFailure& value) { SetReturnValuesOnConditionCheckFailure(value); return *this;} /** *An optional parameter that returns the item attributes for an
* UpdateItem
operation that failed a condition check.
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.
*/ inline UpdateItemRequest& WithReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure&& value) { SetReturnValuesOnConditionCheckFailure(std::move(value)); return *this;} private: Aws::String m_tableName; bool m_tableNameHasBeenSet = false; Aws::Map