Conditional put Conditional deletes Conditional updates Conditional expression examples

Condition expressions

To manipulate data in an Amazon DynamoDB table, you use the PutItem, UpdateItem, and DeleteItem operations. (You can also use BatchWriteItem to perform multiple PutItem or DeleteItem operations in a single call.)

For these data manipulation operations, you can specify a condition expression to determine which items should be modified. If the condition expression evaluates to true, the operation succeeds; otherwise, the operation fails.

The following are some Amazon Command Line Interface (Amazon CLI) examples of using condition expressions. These examples are based on the ProductCatalog table, which was introduced in Specifying item attributes when using expressions. The partition key for this table is Id; there is no sort key. The following PutItem operation creates a sample ProductCatalog item that the examples refer to.


aws dynamodb put-item \
    --table-name ProductCatalog \
    --item file://item.json

The arguments for --item are stored in the item.json file. (For simplicity, only a few item attributes are used.)


{
    "Id": {"N": "456" },
    "ProductCategory": {"S": "Sporting Goods" },
    "Price": {"N": "650" }
}

Topics

Conditional put
Conditional deletes
Conditional updates
Conditional expression examples
Comparison operator and function reference

Conditional put

The PutItem operation overwrites an item with the same primary key (if it exists). If you want to avoid this, use a condition expression. This allows the write to proceed only if the item in question does not already have the same primary key.

The following example uses attribute_not_exists() to check whether the primary key exists in the table before attempting the write operation.

Note

If your primary key consists of both a partition key(pk) and a sort key(sk), the parameter will check whether attribute_not_exists(pk) AND attribute_not_exists(sk) evaluate to true or false before attempting the write operation.


aws dynamodb put-item \
    --table-name ProductCatalog \
    --item file://item.json \
    --condition-expression "attribute_not_exists(Id)"

If the condition expression evaluates to false, DynamoDB returns the following error message: The conditional request failed.

Note

For more information about attribute_not_exists and other functions, see Comparison operator and function reference.

Conditional deletes

To perform a conditional delete, you use a DeleteItem operation with a condition expression. The condition expression must evaluate to true in order for the operation to succeed; otherwise, the operation fails.

Consider the item from Condition expressions.


{
    "Id": {
        "N": "456"
    },
    "Price": {
        "N": "650"
    },
    "ProductCategory": {
        "S": "Sporting Goods"
    }
}

Suppose that you wanted to delete the item, but only under the following conditions:

The ProductCategory is either "Sporting Goods" or "Gardening Supplies."
The Price is between 500 and 600.

The following example tries to delete the item.


aws dynamodb delete-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"456"}}' \
    --condition-expression "(ProductCategory IN (:cat1, :cat2)) and (Price between :lo and :hi)" \
    --expression-attribute-values file://values.json

The arguments for --expression-attribute-values are stored in the values.json file.


{
    ":cat1": {"S": "Sporting Goods"},
    ":cat2": {"S": "Gardening Supplies"},
    ":lo": {"N": "500"},
    ":hi": {"N": "600"}
}

Note

In the condition expression, the : (colon character) indicates an expression attribute value—a placeholder for an actual value. For more information, see Expression attribute values.

For more information about IN, AND, and other keywords, see Comparison operator and function reference.

In this example, the ProductCategory comparison evaluates to true, but the Price comparison evaluates to false. This causes the condition expression to evaluate to false and the DeleteItem operation to fail.

Conditional updates

To perform a conditional update, you use an UpdateItem operation with a condition expression. The condition expression must evaluate to true in order for the operation to succeed; otherwise, the operation fails.

Note

UpdateItem also supports update expressions, where you specify the modifications you want to make to an item. For more information, see Update expressions.

Suppose that you started with the item shown in Condition expressions.


{
    "Id": { "N": "456"},
    "Price": {"N": "650"},
    "ProductCategory": {"S": "Sporting Goods"}
}

The following example performs an UpdateItem operation. It tries to reduce the Price of a product by 75—but the condition expression prevents the update if the current Price is less than or equal to 500.


aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id": {"N": "456"}}' \
    --update-expression "SET Price = Price - :discount" \
    --condition-expression "Price > :limit" \
    --expression-attribute-values file://values.json

The arguments for --expression-attribute-values are stored in the values.json file.


{
    ":discount": { "N": "75"},
    ":limit": {"N": "500"}
}

If the starting Price is 650, the UpdateItem operation reduces the Price to 575. If you run the UpdateItem operation again, the Price is reduced to 500. If you run it a third time, the condition expression evaluates to false, and the update fails.

Note

In the condition expression, the : (colon character) indicates an expression attribute value—a placeholder for an actual value. For more information, see Expression attribute values.

For more information about ">" and other operators, see Comparison operator and function reference.

Conditional expression examples

For more information about the functions used in the following examples, see Comparison operator and function reference. If you want to know more about how to specify different attribute types in an expression, see Specifying item attributes when using expressions.

Checking for attributes in an item

You can check for the existence (or nonexistence) of any attribute. If the condition expression evaluates to true, the operation succeeds; otherwise, it fails.

The following example uses attribute_not_exists to delete a product only if it does not have a Price attribute.


aws dynamodb delete-item \
    --table-name ProductCatalog \
    --key '{"Id": {"N": "456"}}' \
    --condition-expression "attribute_not_exists(Price)"

DynamoDB also provides an attribute_exists function. The following example deletes a product only if it has received poor reviews.


aws dynamodb delete-item \
    --table-name ProductCatalog \
    --key '{"Id": {"N": "456"}}' \
    --condition-expression "attribute_exists(ProductReviews.OneStar)"

Checking for attribute type

You can check the data type of an attribute value by using the attribute_type function. If the condition expression evaluates to true, the operation succeeds; otherwise, it fails.

The following example uses attribute_type to delete a product only if it has a Color attribute of type String Set.


aws dynamodb delete-item \
    --table-name ProductCatalog \
    --key '{"Id": {"N": "456"}}' \
    --condition-expression "attribute_type(Color, :v_sub)" \
    --expression-attribute-values file://expression-attribute-values.json

The arguments for --expression-attribute-values are stored in the expression-attribute-values.json file.


{
    ":v_sub":{"S":"SS"}
}

Checking string starting value

You can check if a String attribute value begins with a particular substring by using the begins_with function. If the condition expression evaluates to true, the operation succeeds; otherwise, it fails.

The following example uses begins_with to delete a product only if the FrontView element of the Pictures map starts with a specific value.


aws dynamodb delete-item \
    --table-name ProductCatalog \
    --key '{"Id": {"N": "456"}}' \
    --condition-expression "begins_with(Pictures.FrontView, :v_sub)" \
    --expression-attribute-values file://expression-attribute-values.json

The arguments for --expression-attribute-values are stored in the expression-attribute-values.json file.


{
    ":v_sub":{"S":"http://"}
}

Checking for an element in a set

You can check for an element in a set or look for a substring within a string by using the contains function. If the condition expression evaluates to true, the operation succeeds; otherwise, it fails.

The following example uses contains to delete a product only if the Color String Set has an element with a specific value.


aws dynamodb delete-item \
    --table-name ProductCatalog \
    --key '{"Id": {"N": "456"}}' \
    --condition-expression "contains(Color, :v_sub)" \
    --expression-attribute-values file://expression-attribute-values.json

The arguments for --expression-attribute-values are stored in the expression-attribute-values.json file.


{
    ":v_sub":{"S":"Red"}
}

Checking the size of an attribute value

You can check for the size of an attribute value by using the size function. If the condition expression evaluates to true, the operation succeeds; otherwise, it fails.

The following example uses size to delete a product only if the size of the VideoClip Binary attribute is greater than 64000 bytes.


aws dynamodb delete-item \
    --table-name ProductCatalog \
    --key '{"Id": {"N": "456"}}' \
    --condition-expression "size(VideoClip) > :v_sub" \
    --expression-attribute-values file://expression-attribute-values.json

The arguments for --expression-attribute-values are stored in the expression-attribute-values.json file.


{
    ":v_sub":{"N":"64000"}
}

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Expression attribute values

Comparison operator and function reference