ConditionCheck
Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item.
Contents
Note
In the following list, the required parameters are described first.
- ConditionExpression
-
A condition that must be satisfied in order for a conditional update to succeed. For more information, see Condition expressions in the Amazon DynamoDB Developer Guide.
Type: String
Required: Yes
- Key
-
The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.
Type: String to AttributeValue object map
Key Length Constraints: Maximum length of 65535.
Required: Yes
- TableName
-
Name of the table for the check item request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
- ExpressionAttributeNames
-
One or more substitution tokens for attribute names in an expression. For more information, see Expression attribute names in the Amazon DynamoDB Developer Guide.
Type: String to string map
Value Length Constraints: Maximum length of 65535.
Required: No
- ExpressionAttributeValues
-
One or more values that can be substituted in an expression. For more information, see Condition expressions in the Amazon DynamoDB Developer Guide.
Type: String to AttributeValue object map
Required: No
- ReturnValuesOnConditionCheckFailure
-
Use
ReturnValuesOnConditionCheckFailureto get the item attributes if theConditionCheckcondition fails. ForReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.Type: String
Valid Values:
ALL_OLD | NONERequired: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: