# update-item ## Description Edits an existing item’s attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn’t exist, or replace an existing name-value pair if it has certain expected attribute values). You can also return the item’s attribute values in the same `UpdateItem` operation using the `ReturnValues` parameter. See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateItem) ## Synopsis ``` update-item --table-name --key [--attribute-updates ] [--expected ] [--conditional-operator ] [--return-values ] [--return-consumed-capacity ] [--return-item-collection-metrics ] [--update-expression ] [--condition-expression ] [--expression-attribute-names ] [--expression-attribute-values ] [--return-values-on-condition-check-failure ] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] ``` ## Options `--table-name` (string) [required] > The name of the table containing the item to update. You can also provide the Amazon Resource Name (ARN) of the table in this parameter. > Constraints: > * min: `1` > * max: `1024` `--key` (map) [required] > 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. > key -> (string) > > Constraints: > > * max: `65535` > value -> (structure) > > Represents the data for an attribute. > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > S -> (string) > > > An attribute of type String. For example: > > > > `"S": "Hello"` > > N -> (string) > > > An attribute of type Number. For example: > > > > `"N": "123.45"` > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > B -> (blob) > > > An attribute of type Binary. For example: > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > SS -> (list) > > > An attribute of type String Set. For example: > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > (string) > > NS -> (list) > > > An attribute of type Number Set. For example: > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > (string) > > BS -> (list) > > > An attribute of type Binary Set. For example: > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > (blob) > > M -> (map) > > > An attribute of type Map. For example: > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > key -> (string) > > > > Constraints: > > > > * max: `65535` > > > value -> (structure) > > > > Represents the data for an attribute. > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > S -> (string) > > > > > An attribute of type String. For example: > > > > > > `"S": "Hello"` > > > > N -> (string) > > > > > An attribute of type Number. For example: > > > > > > `"N": "123.45"` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > B -> (blob) > > > > > An attribute of type Binary. For example: > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > SS -> (list) > > > > > An attribute of type String Set. For example: > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > (string) > > > > NS -> (list) > > > > > An attribute of type Number Set. For example: > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > (string) > > > > BS -> (list) > > > > > An attribute of type Binary Set. For example: > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > (blob) > > > > M -> (map) > > > > > An attribute of type Map. For example: > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > key -> (string) > > > > > > Constraints: > > > > > > * max: `65535` > > > > > ( … recursive … ) > > > > L -> (list) > > > > > An attribute of type List. For example: > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > ( … recursive … ) > > > > NULL -> (boolean) > > > > > An attribute of type Null. For example: > > > > > > `"NULL": true` > > > > BOOL -> (boolean) > > > > > An attribute of type Boolean. For example: > > > > > > `"BOOL": true` > > L -> (list) > > > An attribute of type List. For example: > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > (structure) > > > > Represents the data for an attribute. > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > S -> (string) > > > > > An attribute of type String. For example: > > > > > > `"S": "Hello"` > > > > N -> (string) > > > > > An attribute of type Number. For example: > > > > > > `"N": "123.45"` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > B -> (blob) > > > > > An attribute of type Binary. For example: > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > SS -> (list) > > > > > An attribute of type String Set. For example: > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > (string) > > > > NS -> (list) > > > > > An attribute of type Number Set. For example: > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > (string) > > > > BS -> (list) > > > > > An attribute of type Binary Set. For example: > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > (blob) > > > > M -> (map) > > > > > An attribute of type Map. For example: > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > key -> (string) > > > > > > Constraints: > > > > > > * max: `65535` > > > > > ( … recursive … ) > > > > L -> (list) > > > > > An attribute of type List. For example: > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > ( … recursive … ) > > > > NULL -> (boolean) > > > > > An attribute of type Null. For example: > > > > > > `"NULL": true` > > > > BOOL -> (boolean) > > > > > An attribute of type Boolean. For example: > > > > > > `"BOOL": true` > > NULL -> (boolean) > > > An attribute of type Null. For example: > > > > `"NULL": true` > > BOOL -> (boolean) > > > An attribute of type Boolean. For example: > > > > `"BOOL": true` JSON Syntax: ```json {"string": { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { ... recursive ... } ...}, "L": [ { ... recursive ... } ... ], "NULL": true|false, "BOOL": true|false } ...}, "L": [ { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { ... recursive ... } ...}, "L": [ { ... recursive ... } ... ], "NULL": true|false, "BOOL": true|false } ... ], "NULL": true|false, "BOOL": true|false } ...} ``` `--attribute-updates` (map) > This is a legacy parameter. Use `UpdateExpression` instead. For more information, see [AttributeUpdates](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html) in the *Amazon DynamoDB Developer Guide* . > key -> (string) > > Constraints: > > * max: `65535` > value -> (structure) > > For the `UpdateItem` operation, represents the attributes to be modified, the action to perform on each, and the new value for each. > > #### NOTE > > You cannot use `UpdateItem` to update any primary key attributes. Instead, you will need to delete the item, and then use `PutItem` to create a new item with new attributes. > > Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a `ValidationException` exception. > > Value -> (structure) > > > Represents the data for an attribute. > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > S -> (string) > > > > An attribute of type String. For example: > > > > > `"S": "Hello"` > > > N -> (string) > > > > An attribute of type Number. For example: > > > > > `"N": "123.45"` > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > B -> (blob) > > > > An attribute of type Binary. For example: > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > SS -> (list) > > > > An attribute of type String Set. For example: > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > (string) > > > NS -> (list) > > > > An attribute of type Number Set. For example: > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > (string) > > > BS -> (list) > > > > An attribute of type Binary Set. For example: > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > (blob) > > > M -> (map) > > > > An attribute of type Map. For example: > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > key -> (string) > > > > > Constraints: > > > > > * max: `65535` > > > > value -> (structure) > > > > > Represents the data for an attribute. > > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > > S -> (string) > > > > > > An attribute of type String. For example: > > > > > > > `"S": "Hello"` > > > > > N -> (string) > > > > > > An attribute of type Number. For example: > > > > > > > `"N": "123.45"` > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > B -> (blob) > > > > > > An attribute of type Binary. For example: > > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > > SS -> (list) > > > > > > An attribute of type String Set. For example: > > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > > (string) > > > > > NS -> (list) > > > > > > An attribute of type Number Set. For example: > > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > > (string) > > > > > BS -> (list) > > > > > > An attribute of type Binary Set. For example: > > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > > (blob) > > > > > M -> (map) > > > > > > An attribute of type Map. For example: > > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > > key -> (string) > > > > > > > Constraints: > > > > > > > * max: `65535` > > > > > > ( … recursive … ) > > > > > L -> (list) > > > > > > An attribute of type List. For example: > > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > > ( … recursive … ) > > > > > NULL -> (boolean) > > > > > > An attribute of type Null. For example: > > > > > > > `"NULL": true` > > > > > BOOL -> (boolean) > > > > > > An attribute of type Boolean. For example: > > > > > > > `"BOOL": true` > > > L -> (list) > > > > An attribute of type List. For example: > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > (structure) > > > > > Represents the data for an attribute. > > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > > S -> (string) > > > > > > An attribute of type String. For example: > > > > > > > `"S": "Hello"` > > > > > N -> (string) > > > > > > An attribute of type Number. For example: > > > > > > > `"N": "123.45"` > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > B -> (blob) > > > > > > An attribute of type Binary. For example: > > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > > SS -> (list) > > > > > > An attribute of type String Set. For example: > > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > > (string) > > > > > NS -> (list) > > > > > > An attribute of type Number Set. For example: > > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > > (string) > > > > > BS -> (list) > > > > > > An attribute of type Binary Set. For example: > > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > > (blob) > > > > > M -> (map) > > > > > > An attribute of type Map. For example: > > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > > key -> (string) > > > > > > > Constraints: > > > > > > > * max: `65535` > > > > > > ( … recursive … ) > > > > > L -> (list) > > > > > > An attribute of type List. For example: > > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > > ( … recursive … ) > > > > > NULL -> (boolean) > > > > > > An attribute of type Null. For example: > > > > > > > `"NULL": true` > > > > > BOOL -> (boolean) > > > > > > An attribute of type Boolean. For example: > > > > > > > `"BOOL": true` > > > NULL -> (boolean) > > > > An attribute of type Null. For example: > > > > > `"NULL": true` > > > BOOL -> (boolean) > > > > An attribute of type Boolean. For example: > > > > > `"BOOL": true` > > Action -> (string) > > > Specifies how to perform the update. Valid values are `PUT` (default), `DELETE` , and `ADD` . The behavior depends on whether the specified primary key already exists in the table. > > > > **If an item with the specified \*Key\* is found in the table:** > > > * `PUT` - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. > > > * `DELETE` - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value’s data type. 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 specified `[a,c]` , then the final attribute value would be `[b]` . Specifying an empty set is an error. > > > * `ADD` - If the attribute does not already exist, then the attribute and its values are added to the item. 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 the `Value` is mathematically added to the existing attribute. If `Value` is a negative number, then it is subtracted from the existing attribute. > > > #### NOTE > > > 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. In addition, if you use `ADD` to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses `0` as the initial value. For example, suppose that the item you want to update does not yet have an attribute named *itemcount* , but you decide to `ADD` the number `3` to this attribute anyway, even though it currently does not exist. 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 the `Value` is also a set, then the `Value` is added to the existing set. (This is a *set* operation, not mathematical addition.) For example, if the attribute value was the set `[1,2]` , and the `ADD` action specified `[3]` , then the final attribute value would be `[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 same holds true for number sets and binary sets. > > > This action is only valid for an existing attribute whose data type is number or is a set. Do not use `ADD` for any other data types. > > > > **If no item with the specified \*Key\* is found:** > > > * `PUT` - DynamoDB creates a new item with the specified primary key, and then adds the attribute. > > > * `DELETE` - Nothing happens; there is no attribute to delete. > > > * `ADD` - DynamoDB creates a new item with the supplied primary key and number (or set) for the attribute value. The only data types allowed are number, number set, string set or binary set. > > > Possible values: > > > * `ADD` > > > * `PUT` > > > * `DELETE` JSON Syntax: ```json {"string": { "Value": { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { ... recursive ... } ...}, "L": [ { ... recursive ... } ... ], "NULL": true|false, "BOOL": true|false } ...}, "L": [ { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { ... recursive ... } ...}, "L": [ { ... recursive ... } ... ], "NULL": true|false, "BOOL": true|false } ... ], "NULL": true|false, "BOOL": true|false }, "Action": "ADD"|"PUT"|"DELETE" } ...} ``` `--expected` (map) > This is a legacy parameter. Use `ConditionExpression` instead. For more information, see [Expected](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) in the *Amazon DynamoDB Developer Guide* . > key -> (string) > > Constraints: > > * max: `65535` > value -> (structure) > > Represents a condition to be compared with an attribute value. This condition can be used with `DeleteItem` , `PutItem` , or `UpdateItem` operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use `ExpectedAttributeValue` in one of two different ways: > > * Use `AttributeValueList` to specify one or more values to compare against an attribute. Use `ComparisonOperator` to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds. > > * Use `Value` to specify a value that DynamoDB will compare against an attribute. If the values match, then `ExpectedAttributeValue` evaluates to true and the conditional operation succeeds. Optionally, you can also set `Exists` to false, indicating that you *do not* expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false. > > > `Value` and `Exists` are incompatible with `AttributeValueList` and `ComparisonOperator` . Note that if you use both sets of parameters at once, DynamoDB will return a `ValidationException` exception. > > Value -> (structure) > > > Represents the data for the expected attribute. > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > S -> (string) > > > > An attribute of type String. For example: > > > > > `"S": "Hello"` > > > N -> (string) > > > > An attribute of type Number. For example: > > > > > `"N": "123.45"` > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > B -> (blob) > > > > An attribute of type Binary. For example: > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > SS -> (list) > > > > An attribute of type String Set. For example: > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > (string) > > > NS -> (list) > > > > An attribute of type Number Set. For example: > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > (string) > > > BS -> (list) > > > > An attribute of type Binary Set. For example: > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > (blob) > > > M -> (map) > > > > An attribute of type Map. For example: > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > key -> (string) > > > > > Constraints: > > > > > * max: `65535` > > > > value -> (structure) > > > > > Represents the data for an attribute. > > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > > S -> (string) > > > > > > An attribute of type String. For example: > > > > > > > `"S": "Hello"` > > > > > N -> (string) > > > > > > An attribute of type Number. For example: > > > > > > > `"N": "123.45"` > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > B -> (blob) > > > > > > An attribute of type Binary. For example: > > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > > SS -> (list) > > > > > > An attribute of type String Set. For example: > > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > > (string) > > > > > NS -> (list) > > > > > > An attribute of type Number Set. For example: > > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > > (string) > > > > > BS -> (list) > > > > > > An attribute of type Binary Set. For example: > > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > > (blob) > > > > > M -> (map) > > > > > > An attribute of type Map. For example: > > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > > key -> (string) > > > > > > > Constraints: > > > > > > > * max: `65535` > > > > > > ( … recursive … ) > > > > > L -> (list) > > > > > > An attribute of type List. For example: > > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > > ( … recursive … ) > > > > > NULL -> (boolean) > > > > > > An attribute of type Null. For example: > > > > > > > `"NULL": true` > > > > > BOOL -> (boolean) > > > > > > An attribute of type Boolean. For example: > > > > > > > `"BOOL": true` > > > L -> (list) > > > > An attribute of type List. For example: > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > (structure) > > > > > Represents the data for an attribute. > > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > > S -> (string) > > > > > > An attribute of type String. For example: > > > > > > > `"S": "Hello"` > > > > > N -> (string) > > > > > > An attribute of type Number. For example: > > > > > > > `"N": "123.45"` > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > B -> (blob) > > > > > > An attribute of type Binary. For example: > > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > > SS -> (list) > > > > > > An attribute of type String Set. For example: > > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > > (string) > > > > > NS -> (list) > > > > > > An attribute of type Number Set. For example: > > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > > (string) > > > > > BS -> (list) > > > > > > An attribute of type Binary Set. For example: > > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > > (blob) > > > > > M -> (map) > > > > > > An attribute of type Map. For example: > > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > > key -> (string) > > > > > > > Constraints: > > > > > > > * max: `65535` > > > > > > ( … recursive … ) > > > > > L -> (list) > > > > > > An attribute of type List. For example: > > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > > ( … recursive … ) > > > > > NULL -> (boolean) > > > > > > An attribute of type Null. For example: > > > > > > > `"NULL": true` > > > > > BOOL -> (boolean) > > > > > > An attribute of type Boolean. For example: > > > > > > > `"BOOL": true` > > > NULL -> (boolean) > > > > An attribute of type Null. For example: > > > > > `"NULL": true` > > > BOOL -> (boolean) > > > > An attribute of type Boolean. For example: > > > > > `"BOOL": true` > > Exists -> (boolean) > > > Causes DynamoDB to evaluate the value before attempting a conditional operation: > > > * If `Exists` is `true` , DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a `ConditionCheckFailedException` . > > > * If `Exists` is `false` , DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a `ConditionCheckFailedException` . > > > The default setting for `Exists` is `true` . If you supply a `Value` all by itself, DynamoDB assumes the attribute exists: You don’t have to set `Exists` to `true` , because it is implied. > > > DynamoDB returns a `ValidationException` if: > > > * `Exists` is `true` but there is no `Value` to check. (You expect a value to exist, but don’t specify what that value is.) > > > * `Exists` is `false` but you also provide a `Value` . (You cannot expect an attribute to have a value, while also expecting it not to exist.) > > ComparisonOperator -> (string) > > > A comparator for evaluating attributes in the `AttributeValueList` . For example, equals, greater than, less than, etc. > > > The following comparison operators are available: > > > > `EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN` > > > The following are descriptions of each comparison operator. > > > * `EQ` : Equal. `EQ` is supported for all data types, including lists and maps. `AttributeValueList` can contain only one `AttributeValue` element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an `AttributeValue` element of a different type than the one provided in the request, the value does not match. For example, `{"S":"6"}` does not equal `{"N":"6"}` . Also, `{"N":"6"}` does not equal `{"NS":["6", "2", "1"]}` . > > > * `NE` : Not equal. `NE` is supported for all data types, including lists and maps. `AttributeValueList` can contain only one `AttributeValue` of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an `AttributeValue` of a different type than the one provided in the request, the value does not match. For example, `{"S":"6"}` does not equal `{"N":"6"}` . Also, `{"N":"6"}` does not equal `{"NS":["6", "2", "1"]}` . > > > * `LE` : Less than or equal. `AttributeValueList` can contain only one `AttributeValue` element of type String, Number, or Binary (not a set type). If an item contains an `AttributeValue` element of a different type than the one provided in the request, the value does not match. For example, `{"S":"6"}` does not equal `{"N":"6"}` . Also, `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}` . > > > * `LT` : Less than. `AttributeValueList` can contain only one `AttributeValue` of type String, Number, or Binary (not a set type). If an item contains an `AttributeValue` element of a different type than the one provided in the request, the value does not match. For example, `{"S":"6"}` does not equal `{"N":"6"}` . Also, `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}` . > > > * `GE` : Greater than or equal. `AttributeValueList` can contain only one `AttributeValue` element of type String, Number, or Binary (not a set type). If an item contains an `AttributeValue` element of a different type than the one provided in the request, the value does not match. For example, `{"S":"6"}` does not equal `{"N":"6"}` . Also, `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}` . > > > * `GT` : Greater than. `AttributeValueList` can contain only one `AttributeValue` element of type String, Number, or Binary (not a set type). If an item contains an `AttributeValue` element of a different type than the one provided in the request, the value does not match. For example, `{"S":"6"}` does not equal `{"N":"6"}` . Also, `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}` . > > > * `NOT_NULL` : The attribute exists. `NOT_NULL` is supported for all data types, including lists and maps. > > > #### NOTE > > > This operator tests for the existence of an attribute, not its data type. If the data type of attribute “`a` “ is null, and you evaluate it using `NOT_NULL` , the result is a Boolean `true` . This result is because the attribute “`a` “ exists; its data type is not relevant to the `NOT_NULL` comparison operator. > > > * `NULL` : The attribute does not exist. `NULL` is supported for all data types, including lists and maps. > > > #### NOTE > > > This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute “`a` “ is null, and you evaluate it using `NULL` , the result is a Boolean `false` . This is because the attribute “`a` “ exists; its data type is not relevant to the `NULL` comparison operator. > > > * `CONTAINS` : Checks for a subsequence, or value in a set. `AttributeValueList` can contain only one `AttributeValue` element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (”`SS` “, “`NS` “, or “`BS` “), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating “`a CONTAINS b` “, “`a` “ can be a list; however, “`b` “ cannot be a set, a map, or a list. > > > * `NOT_CONTAINS` : Checks for absence of a subsequence, or absence of a value in a set. `AttributeValueList` can contain only one `AttributeValue` element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (”`SS` “, “`NS` “, or “`BS` “), then the operator evaluates to true if it *does not* find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating “`a NOT CONTAINS b` “, “`a` “ can be a list; however, “`b` “ cannot be a set, a map, or a list. > > > * `BEGINS_WITH` : Checks for a prefix. `AttributeValueList` can contain only one `AttributeValue` of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). > > > * `IN` : Checks for matching elements in a list. `AttributeValueList` can contain one or more `AttributeValue` elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true. > > > * `BETWEEN` : Greater than or equal to the first value, and less than or equal to the second value. `AttributeValueList` must contain two `AttributeValue` elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an `AttributeValue` element of a different type than the one provided in the request, the value does not match. For example, `{"S":"6"}` does not compare to `{"N":"6"}` . Also, `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}` > > > Possible values: > > > * `EQ` > > > * `NE` > > > * `IN` > > > * `LE` > > > * `LT` > > > * `GE` > > > * `GT` > > > * `BETWEEN` > > > * `NOT_NULL` > > > * `NULL` > > > * `CONTAINS` > > > * `NOT_CONTAINS` > > > * `BEGINS_WITH` > > AttributeValueList -> (list) > > > One or more values to evaluate against the supplied attribute. The number of values in the list depends on the `ComparisonOperator` being used. > > > For type Number, value comparisons are numeric. > > > String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, `a` is greater than `A` , and `a` is greater than `B` . For a list of code values, see [http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters](http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters) . > > > For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. > > > For information on specifying data types in JSON, see [JSON Data Format](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html) in the *Amazon DynamoDB Developer Guide* . > > > (structure) > > > > Represents the data for an attribute. > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > S -> (string) > > > > > An attribute of type String. For example: > > > > > > `"S": "Hello"` > > > > N -> (string) > > > > > An attribute of type Number. For example: > > > > > > `"N": "123.45"` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > B -> (blob) > > > > > An attribute of type Binary. For example: > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > SS -> (list) > > > > > An attribute of type String Set. For example: > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > (string) > > > > NS -> (list) > > > > > An attribute of type Number Set. For example: > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > (string) > > > > BS -> (list) > > > > > An attribute of type Binary Set. For example: > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > (blob) > > > > M -> (map) > > > > > An attribute of type Map. For example: > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > key -> (string) > > > > > > Constraints: > > > > > > * max: `65535` > > > > > value -> (structure) > > > > > > Represents the data for an attribute. > > > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > > > S -> (string) > > > > > > > An attribute of type String. For example: > > > > > > > > `"S": "Hello"` > > > > > > N -> (string) > > > > > > > An attribute of type Number. For example: > > > > > > > > `"N": "123.45"` > > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > > B -> (blob) > > > > > > > An attribute of type Binary. For example: > > > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > > > SS -> (list) > > > > > > > An attribute of type String Set. For example: > > > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > > > (string) > > > > > > NS -> (list) > > > > > > > An attribute of type Number Set. For example: > > > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > > > (string) > > > > > > BS -> (list) > > > > > > > An attribute of type Binary Set. For example: > > > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > > > (blob) > > > > > > M -> (map) > > > > > > > An attribute of type Map. For example: > > > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > > > key -> (string) > > > > > > > > Constraints: > > > > > > > > * max: `65535` > > > > > > > ( … recursive … ) > > > > > > L -> (list) > > > > > > > An attribute of type List. For example: > > > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > > > ( … recursive … ) > > > > > > NULL -> (boolean) > > > > > > > An attribute of type Null. For example: > > > > > > > > `"NULL": true` > > > > > > BOOL -> (boolean) > > > > > > > An attribute of type Boolean. For example: > > > > > > > > `"BOOL": true` > > > > L -> (list) > > > > > An attribute of type List. For example: > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > (structure) > > > > > > Represents the data for an attribute. > > > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > > > S -> (string) > > > > > > > An attribute of type String. For example: > > > > > > > > `"S": "Hello"` > > > > > > N -> (string) > > > > > > > An attribute of type Number. For example: > > > > > > > > `"N": "123.45"` > > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > > B -> (blob) > > > > > > > An attribute of type Binary. For example: > > > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > > > SS -> (list) > > > > > > > An attribute of type String Set. For example: > > > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > > > (string) > > > > > > NS -> (list) > > > > > > > An attribute of type Number Set. For example: > > > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > > > (string) > > > > > > BS -> (list) > > > > > > > An attribute of type Binary Set. For example: > > > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > > > (blob) > > > > > > M -> (map) > > > > > > > An attribute of type Map. For example: > > > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > > > key -> (string) > > > > > > > > Constraints: > > > > > > > > * max: `65535` > > > > > > > ( … recursive … ) > > > > > > L -> (list) > > > > > > > An attribute of type List. For example: > > > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > > > ( … recursive … ) > > > > > > NULL -> (boolean) > > > > > > > An attribute of type Null. For example: > > > > > > > > `"NULL": true` > > > > > > BOOL -> (boolean) > > > > > > > An attribute of type Boolean. For example: > > > > > > > > `"BOOL": true` > > > > NULL -> (boolean) > > > > > An attribute of type Null. For example: > > > > > > `"NULL": true` > > > > BOOL -> (boolean) > > > > > An attribute of type Boolean. For example: > > > > > > `"BOOL": true` JSON Syntax: ```json {"string": { "Value": { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { ... recursive ... } ...}, "L": [ { ... recursive ... } ... ], "NULL": true|false, "BOOL": true|false } ...}, "L": [ { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { ... recursive ... } ...}, "L": [ { ... recursive ... } ... ], "NULL": true|false, "BOOL": true|false } ... ], "NULL": true|false, "BOOL": true|false }, "Exists": true|false, "ComparisonOperator": "EQ"|"NE"|"IN"|"LE"|"LT"|"GE"|"GT"|"BETWEEN"|"NOT_NULL"|"NULL"|"CONTAINS"|"NOT_CONTAINS"|"BEGINS_WITH", "AttributeValueList": [ { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { ... recursive ... } ...}, "L": [ { ... recursive ... } ... ], "NULL": true|false, "BOOL": true|false } ...}, "L": [ { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { ... recursive ... } ...}, "L": [ { ... recursive ... } ... ], "NULL": true|false, "BOOL": true|false } ... ], "NULL": true|false, "BOOL": true|false } ... ] } ...} ``` `--conditional-operator` (string) > This is a legacy parameter. Use `ConditionExpression` instead. For more information, see [ConditionalOperator](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) in the *Amazon DynamoDB Developer Guide* . > Possible values: > * `AND` > * `OR` `--return-values` (string) > 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. > Possible values: > * `NONE` > * `ALL_OLD` > * `UPDATED_OLD` > * `ALL_NEW` > * `UPDATED_NEW` `--return-consumed-capacity` (string) > Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response: > * `INDEXES` - The response includes the aggregate `ConsumedCapacity` for the operation, together with `ConsumedCapacity` for each table and secondary index that was accessed. Note that some operations, such as `GetItem` and `BatchGetItem` , do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s). > * `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation. > * `NONE` - No `ConsumedCapacity` details are included in the response. > Possible values: > * `INDEXES` > * `TOTAL` > * `NONE` `--return-item-collection-metrics` (string) > 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. > Possible values: > * `SIZE` > * `NONE` `--update-expression` (string) > 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. > #### NOTE > 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. > #### WARNING > The `ADD` action only supports Number and set data types. > * `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. > #### WARNING > The `DELETE` action only supports set data types. > 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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html) in the *Amazon DynamoDB Developer Guide* . `--condition-expression` (string) > 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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the *Amazon DynamoDB Developer Guide* . `--expression-attribute-names` (map) > 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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) 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` > #### NOTE > 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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the *Amazon DynamoDB Developer Guide* . > key -> (string) > value -> (string) > > Constraints: > > * max: `65535` Shorthand Syntax: ``` KeyName1=string,KeyName2=string ``` JSON Syntax: ```json {"string": "string" ...} ``` `--expression-attribute-values` (map) > 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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the *Amazon DynamoDB Developer Guide* . > key -> (string) > value -> (structure) > > Represents the data for an attribute. > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > S -> (string) > > > An attribute of type String. For example: > > > > `"S": "Hello"` > > N -> (string) > > > An attribute of type Number. For example: > > > > `"N": "123.45"` > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > B -> (blob) > > > An attribute of type Binary. For example: > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > SS -> (list) > > > An attribute of type String Set. For example: > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > (string) > > NS -> (list) > > > An attribute of type Number Set. For example: > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > (string) > > BS -> (list) > > > An attribute of type Binary Set. For example: > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > (blob) > > M -> (map) > > > An attribute of type Map. For example: > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > key -> (string) > > > > Constraints: > > > > * max: `65535` > > > value -> (structure) > > > > Represents the data for an attribute. > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > S -> (string) > > > > > An attribute of type String. For example: > > > > > > `"S": "Hello"` > > > > N -> (string) > > > > > An attribute of type Number. For example: > > > > > > `"N": "123.45"` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > B -> (blob) > > > > > An attribute of type Binary. For example: > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > SS -> (list) > > > > > An attribute of type String Set. For example: > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > (string) > > > > NS -> (list) > > > > > An attribute of type Number Set. For example: > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > (string) > > > > BS -> (list) > > > > > An attribute of type Binary Set. For example: > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > (blob) > > > > M -> (map) > > > > > An attribute of type Map. For example: > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > key -> (string) > > > > > > Constraints: > > > > > > * max: `65535` > > > > > ( … recursive … ) > > > > L -> (list) > > > > > An attribute of type List. For example: > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > ( … recursive … ) > > > > NULL -> (boolean) > > > > > An attribute of type Null. For example: > > > > > > `"NULL": true` > > > > BOOL -> (boolean) > > > > > An attribute of type Boolean. For example: > > > > > > `"BOOL": true` > > L -> (list) > > > An attribute of type List. For example: > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > (structure) > > > > Represents the data for an attribute. > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > S -> (string) > > > > > An attribute of type String. For example: > > > > > > `"S": "Hello"` > > > > N -> (string) > > > > > An attribute of type Number. For example: > > > > > > `"N": "123.45"` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > B -> (blob) > > > > > An attribute of type Binary. For example: > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > SS -> (list) > > > > > An attribute of type String Set. For example: > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > (string) > > > > NS -> (list) > > > > > An attribute of type Number Set. For example: > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > (string) > > > > BS -> (list) > > > > > An attribute of type Binary Set. For example: > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > (blob) > > > > M -> (map) > > > > > An attribute of type Map. For example: > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > key -> (string) > > > > > > Constraints: > > > > > > * max: `65535` > > > > > ( … recursive … ) > > > > L -> (list) > > > > > An attribute of type List. For example: > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > ( … recursive … ) > > > > NULL -> (boolean) > > > > > An attribute of type Null. For example: > > > > > > `"NULL": true` > > > > BOOL -> (boolean) > > > > > An attribute of type Boolean. For example: > > > > > > `"BOOL": true` > > NULL -> (boolean) > > > An attribute of type Null. For example: > > > > `"NULL": true` > > BOOL -> (boolean) > > > An attribute of type Boolean. For example: > > > > `"BOOL": true` JSON Syntax: ```json {"string": { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { ... recursive ... } ...}, "L": [ { ... recursive ... } ... ], "NULL": true|false, "BOOL": true|false } ...}, "L": [ { "S": "string", "N": "string", "B": blob, "SS": ["string", ...], "NS": ["string", ...], "BS": [blob, ...], "M": {"string": { ... recursive ... } ...}, "L": [ { ... recursive ... } ... ], "NULL": true|false, "BOOL": true|false } ... ], "NULL": true|false, "BOOL": true|false } ...} ``` `--return-values-on-condition-check-failure` (string) > 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. > Possible values: > * `ALL_OLD` > * `NONE` `--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`. `--generate-cli-skeleton` (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated. ## Global Options `--debug` (boolean) Turn on debug logging. `--endpoint-url` (string) Override command’s default URL with the given URL. `--no-verify-ssl` (boolean) By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates. `--no-paginate` (boolean) Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results. `--output` (string) The formatting style for command output. * json * text * table * yaml * yaml-stream * off `--query` (string) A JMESPath query to use in filtering the response data. `--profile` (string) Use a specific profile from your credential file. `--region` (string) The region to use. Overrides config/env settings. `--version` (string) Display the version of this tool. `--color` (string) Turn on/off color output. * on * off * auto `--no-sign-request` (boolean) Do not sign requests. Credentials will not be loaded if this argument is provided. `--ca-bundle` (string) The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings. `--cli-read-timeout` (int) The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds. `--cli-connect-timeout` (int) The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds. `--cli-binary-format` (string) The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`. * base64 * raw-in-base64-out `--no-cli-pager` (boolean) Disable cli pager for output. `--cli-auto-prompt` (boolean) Automatically prompt for CLI input parameters. `--no-cli-auto-prompt` (boolean) Disable automatically prompt for CLI input parameters. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced ## Examples #### NOTE To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information. Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* . **Example 1: To update an item in a table** The following `update-item` example updates an item in the `MusicCollection` table. It adds a new attribute (`Year`) and modifies the `AlbumTitle` attribute. All of the attributes in the item, as they appear after the update, are returned in the response. ```bash aws dynamodb update-item \ --table-name MusicCollection \ --key file://key.json \ --update-expression "SET #Y = :y, #AT = :t" \ --expression-attribute-names file://expression-attribute-names.json \ --expression-attribute-values file://expression-attribute-values.json \ --return-values ALL_NEW \ --return-consumed-capacity TOTAL \ --return-item-collection-metrics SIZE ``` Contents of `key.json`: ```json { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} } ``` Contents of `expression-attribute-names.json`: ```json { "#Y":"Year", "#AT":"AlbumTitle" } ``` Contents of `expression-attribute-values.json`: ```json { ":y":{"N": "2015"}, ":t":{"S": "Louder Than Ever"} } ``` Output: ```json { "Attributes": { "AlbumTitle": { "S": "Louder Than Ever" }, "Awards": { "N": "10" }, "Artist": { "S": "Acme Band" }, "Year": { "N": "2015" }, "SongTitle": { "S": "Happy Day" } }, "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 3.0 }, "ItemCollectionMetrics": { "ItemCollectionKey": { "Artist": { "S": "Acme Band" } }, "SizeEstimateRangeGB": [ 0.0, 1.0 ] } } ``` For more information, see [Writing an Item](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData) in the *Amazon DynamoDB Developer Guide*. **Example 2: To update an item conditionally** The following `update-item` example updates an item in the `MusicCollection` table, but only if the existing item does not already have a `Year` attribute. ```bash aws dynamodb update-item \ --table-name MusicCollection \ --key file://key.json \ --update-expression "SET #Y = :y, #AT = :t" \ --expression-attribute-names file://expression-attribute-names.json \ --expression-attribute-values file://expression-attribute-values.json \ --condition-expression "attribute_not_exists(#Y)" ``` Contents of `key.json`: ```json { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} } ``` Contents of `expression-attribute-names.json`: ```json { "#Y":"Year", "#AT":"AlbumTitle" } ``` Contents of `expression-attribute-values.json`: ```json { ":y":{"N": "2015"}, ":t":{"S": "Louder Than Ever"} } ``` This command produces no output. DynamoDB updates the item only if it does not already have a `Year` attribute. If the item already has a `Year` attribute, the command fails with the following error. ``` An error occurred (ConditionalCheckFailedException) when calling the UpdateItem operation: The conditional request failed ``` For more information, see [Writing an Item](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData) in the *Amazon DynamoDB Developer Guide*. ## Output Attributes -> (map) > A map of attribute values as they appear before or after the `UpdateItem` operation, as determined by the `ReturnValues` parameter. > The `Attributes` map is only present if the update was successful and `ReturnValues` was specified as something other than `NONE` in the request. Each element represents one attribute. > key -> (string) > > Constraints: > > * max: `65535` > value -> (structure) > > Represents the data for an attribute. > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > S -> (string) > > > An attribute of type String. For example: > > > > `"S": "Hello"` > > N -> (string) > > > An attribute of type Number. For example: > > > > `"N": "123.45"` > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > B -> (blob) > > > An attribute of type Binary. For example: > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > SS -> (list) > > > An attribute of type String Set. For example: > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > (string) > > NS -> (list) > > > An attribute of type Number Set. For example: > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > (string) > > BS -> (list) > > > An attribute of type Binary Set. For example: > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > (blob) > > M -> (map) > > > An attribute of type Map. For example: > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > key -> (string) > > > > Constraints: > > > > * max: `65535` > > > value -> (structure) > > > > Represents the data for an attribute. > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > S -> (string) > > > > > An attribute of type String. For example: > > > > > > `"S": "Hello"` > > > > N -> (string) > > > > > An attribute of type Number. For example: > > > > > > `"N": "123.45"` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > B -> (blob) > > > > > An attribute of type Binary. For example: > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > SS -> (list) > > > > > An attribute of type String Set. For example: > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > (string) > > > > NS -> (list) > > > > > An attribute of type Number Set. For example: > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > (string) > > > > BS -> (list) > > > > > An attribute of type Binary Set. For example: > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > (blob) > > > > M -> (map) > > > > > An attribute of type Map. For example: > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > key -> (string) > > > > > > Constraints: > > > > > > * max: `65535` > > > > > ( … recursive … ) > > > > L -> (list) > > > > > An attribute of type List. For example: > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > ( … recursive … ) > > > > NULL -> (boolean) > > > > > An attribute of type Null. For example: > > > > > > `"NULL": true` > > > > BOOL -> (boolean) > > > > > An attribute of type Boolean. For example: > > > > > > `"BOOL": true` > > L -> (list) > > > An attribute of type List. For example: > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > (structure) > > > > Represents the data for an attribute. > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > S -> (string) > > > > > An attribute of type String. For example: > > > > > > `"S": "Hello"` > > > > N -> (string) > > > > > An attribute of type Number. For example: > > > > > > `"N": "123.45"` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > B -> (blob) > > > > > An attribute of type Binary. For example: > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > SS -> (list) > > > > > An attribute of type String Set. For example: > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > (string) > > > > NS -> (list) > > > > > An attribute of type Number Set. For example: > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > (string) > > > > BS -> (list) > > > > > An attribute of type Binary Set. For example: > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > (blob) > > > > M -> (map) > > > > > An attribute of type Map. For example: > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > key -> (string) > > > > > > Constraints: > > > > > > * max: `65535` > > > > > ( … recursive … ) > > > > L -> (list) > > > > > An attribute of type List. For example: > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > ( … recursive … ) > > > > NULL -> (boolean) > > > > > An attribute of type Null. For example: > > > > > > `"NULL": true` > > > > BOOL -> (boolean) > > > > > An attribute of type Boolean. For example: > > > > > > `"BOOL": true` > > NULL -> (boolean) > > > An attribute of type Null. For example: > > > > `"NULL": true` > > BOOL -> (boolean) > > > An attribute of type Boolean. For example: > > > > `"BOOL": true` ConsumedCapacity -> (structure) > The capacity units consumed by the `UpdateItem` operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see [Capacity unity consumption for write operations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#write-operation-consumption) in the *Amazon DynamoDB Developer Guide* . > If the table has vector indexes, the response includes a `VectorIndexes` field with `VectorWriteRequestBytes` consumed for each affected vector index. > TableName -> (string) > > The name of the table that was affected by the operation. If you had specified the Amazon Resource Name (ARN) of a table in the input, you’ll see the table ARN in the response. > > Constraints: > > * min: `1` > > * max: `1024` > CapacityUnits -> (double) > > The total number of capacity units consumed by the operation. > ReadCapacityUnits -> (double) > > The total number of read capacity units consumed by the operation. > WriteCapacityUnits -> (double) > > The total number of write capacity units consumed by the operation. > Table -> (structure) > > The amount of throughput consumed on the table affected by the operation. > > ReadCapacityUnits -> (double) > > > The total number of read capacity units consumed on a table or an index. > > WriteCapacityUnits -> (double) > > > The total number of write capacity units consumed on a table or an index. > > CapacityUnits -> (double) > > > The total number of capacity units consumed on a table or an index. > LocalSecondaryIndexes -> (map) > > The amount of throughput consumed on each local index affected by the operation. > > key -> (string) > > > Constraints: > > > * min: `3` > > > * max: `255` > > > * pattern: `[a-zA-Z0-9_.-]+` > > value -> (structure) > > > Represents the amount of provisioned throughput capacity consumed on a table or an index. > > > ReadCapacityUnits -> (double) > > > > The total number of read capacity units consumed on a table or an index. > > > WriteCapacityUnits -> (double) > > > > The total number of write capacity units consumed on a table or an index. > > > CapacityUnits -> (double) > > > > The total number of capacity units consumed on a table or an index. > GlobalSecondaryIndexes -> (map) > > The amount of throughput consumed on each global index affected by the operation. > > key -> (string) > > > Constraints: > > > * min: `3` > > > * max: `255` > > > * pattern: `[a-zA-Z0-9_.-]+` > > value -> (structure) > > > Represents the amount of provisioned throughput capacity consumed on a table or an index. > > > ReadCapacityUnits -> (double) > > > > The total number of read capacity units consumed on a table or an index. > > > WriteCapacityUnits -> (double) > > > > The total number of write capacity units consumed on a table or an index. > > > CapacityUnits -> (double) > > > > The total number of capacity units consumed on a table or an index. > VectorIndexes -> (map) > > The amount of throughput consumed on each vector index affected by the operation. Each entry contains `VectorWriteRequestBytes` (for write operations) or `VectorSearchRequestBytes` (for search operations). > > key -> (string) > > > Constraints: > > > * min: `3` > > > * max: `255` > > > * pattern: `[a-zA-Z0-9_.-]+` > > value -> (structure) > > > The consumed capacity for vector index operations, including vector search request bytes and vector write request bytes. > > > VectorSearchRequestBytes -> (double) > > > > The number of vector search request bytes consumed by a `SearchVectors` operation. > > > VectorWriteRequestBytes -> (double) > > > > The number of vector write request bytes consumed when writing to a vector index. Reported for write operations that modify attributes indexed by a vector index. ItemCollectionMetrics -> (structure) > Information about item collections, if any, that were affected by the `UpdateItem` operation. `ItemCollectionMetrics` is only returned if the `ReturnItemCollectionMetrics` parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. > Each `ItemCollectionMetrics` element consists of: > * `ItemCollectionKey` - The partition key value of the item collection. This is the same as the partition key value of the item itself. > * `SizeEstimateRangeGB` - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. > ItemCollectionKey -> (map) > > The partition key value of the item collection. This value is the same as the partition key value of the item. > > key -> (string) > > > Constraints: > > > * max: `65535` > > value -> (structure) > > > Represents the data for an attribute. > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > S -> (string) > > > > An attribute of type String. For example: > > > > > `"S": "Hello"` > > > N -> (string) > > > > An attribute of type Number. For example: > > > > > `"N": "123.45"` > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > B -> (blob) > > > > An attribute of type Binary. For example: > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > SS -> (list) > > > > An attribute of type String Set. For example: > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > (string) > > > NS -> (list) > > > > An attribute of type Number Set. For example: > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > (string) > > > BS -> (list) > > > > An attribute of type Binary Set. For example: > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > (blob) > > > M -> (map) > > > > An attribute of type Map. For example: > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > key -> (string) > > > > > Constraints: > > > > > * max: `65535` > > > > value -> (structure) > > > > > Represents the data for an attribute. > > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > > S -> (string) > > > > > > An attribute of type String. For example: > > > > > > > `"S": "Hello"` > > > > > N -> (string) > > > > > > An attribute of type Number. For example: > > > > > > > `"N": "123.45"` > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > B -> (blob) > > > > > > An attribute of type Binary. For example: > > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > > SS -> (list) > > > > > > An attribute of type String Set. For example: > > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > > (string) > > > > > NS -> (list) > > > > > > An attribute of type Number Set. For example: > > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > > (string) > > > > > BS -> (list) > > > > > > An attribute of type Binary Set. For example: > > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > > (blob) > > > > > M -> (map) > > > > > > An attribute of type Map. For example: > > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > > key -> (string) > > > > > > > Constraints: > > > > > > > * max: `65535` > > > > > > ( … recursive … ) > > > > > L -> (list) > > > > > > An attribute of type List. For example: > > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > > ( … recursive … ) > > > > > NULL -> (boolean) > > > > > > An attribute of type Null. For example: > > > > > > > `"NULL": true` > > > > > BOOL -> (boolean) > > > > > > An attribute of type Boolean. For example: > > > > > > > `"BOOL": true` > > > L -> (list) > > > > An attribute of type List. For example: > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > (structure) > > > > > Represents the data for an attribute. > > > > > Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. > > > > > For more information, see [Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the *Amazon DynamoDB Developer Guide* . > > > > > S -> (string) > > > > > > An attribute of type String. For example: > > > > > > > `"S": "Hello"` > > > > > N -> (string) > > > > > > An attribute of type Number. For example: > > > > > > > `"N": "123.45"` > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > B -> (blob) > > > > > > An attribute of type Binary. For example: > > > > > > > `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` > > > > > SS -> (list) > > > > > > An attribute of type String Set. For example: > > > > > > > `"SS": ["Giraffe", "Hippo" ,"Zebra"]` > > > > > > (string) > > > > > NS -> (list) > > > > > > An attribute of type Number Set. For example: > > > > > > > `"NS": ["42.2", "-19", "7.5", "3.14"]` > > > > > > Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. > > > > > > (string) > > > > > BS -> (list) > > > > > > An attribute of type Binary Set. For example: > > > > > > > `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` > > > > > > (blob) > > > > > M -> (map) > > > > > > An attribute of type Map. For example: > > > > > > > `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` > > > > > > key -> (string) > > > > > > > Constraints: > > > > > > > * max: `65535` > > > > > > ( … recursive … ) > > > > > L -> (list) > > > > > > An attribute of type List. For example: > > > > > > > `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` > > > > > > ( … recursive … ) > > > > > NULL -> (boolean) > > > > > > An attribute of type Null. For example: > > > > > > > `"NULL": true` > > > > > BOOL -> (boolean) > > > > > > An attribute of type Boolean. For example: > > > > > > > `"BOOL": true` > > > NULL -> (boolean) > > > > An attribute of type Null. For example: > > > > > `"NULL": true` > > > BOOL -> (boolean) > > > > An attribute of type Boolean. For example: > > > > > `"BOOL": true` > SizeEstimateRangeGB -> (list) > > An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. > > The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. > > (double)