public class DeleteItemRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a DeleteItem operation.
NOOP| Constructor and Description |
|---|
DeleteItemRequest()
Default constructor for DeleteItemRequest object.
|
DeleteItemRequest(String tableName,
Map<String,AttributeValue> key)
Constructs a new DeleteItemRequest object.
|
DeleteItemRequest(String tableName,
Map<String,AttributeValue> key,
ReturnValue returnValues)
Constructs a new DeleteItemRequest object.
|
DeleteItemRequest(String tableName,
Map<String,AttributeValue> key,
String returnValues)
Constructs a new DeleteItemRequest object.
|
| Modifier and Type | Method and Description |
|---|---|
DeleteItemRequest |
addExpectedEntry(String key,
ExpectedAttributeValue value) |
DeleteItemRequest |
addExpressionAttributeNamesEntry(String key,
String value) |
DeleteItemRequest |
addExpressionAttributeValuesEntry(String key,
AttributeValue value) |
DeleteItemRequest |
addKeyEntry(String key,
AttributeValue value) |
DeleteItemRequest |
clearExpectedEntries()
Removes all the entries added into Expected.
|
DeleteItemRequest |
clearExpressionAttributeNamesEntries()
Removes all the entries added into ExpressionAttributeNames.
|
DeleteItemRequest |
clearExpressionAttributeValuesEntries()
Removes all the entries added into ExpressionAttributeValues.
|
DeleteItemRequest |
clearKeyEntries()
Removes all the entries added into Key.
|
DeleteItemRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getConditionalOperator()
|
String |
getConditionExpression()
A condition that must be satisfied in order for a conditional
DeleteItem to succeed.
|
Map<String,ExpectedAttributeValue> |
getExpected()
|
Map<String,String> |
getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression.
|
Map<String,AttributeValue> |
getExpressionAttributeValues()
One or more values that can be substituted in an expression.
|
Map<String,AttributeValue> |
getKey()
A map of attribute names to AttributeValue objects, representing
the primary key of the item to delete.
|
String |
getReturnConsumedCapacity() |
String |
getReturnItemCollectionMetrics()
Determines whether item collection metrics are returned.
|
String |
getReturnValues()
Use ReturnValues if you want to get the item attributes as they
appeared before they were deleted.
|
String |
getTableName()
The name of the table from which to delete the item.
|
int |
hashCode() |
void |
setConditionalOperator(ConditionalOperator conditionalOperator)
|
void |
setConditionalOperator(String conditionalOperator)
|
void |
setConditionExpression(String conditionExpression)
A condition that must be satisfied in order for a conditional
DeleteItem to succeed.
|
void |
setExpected(Map<String,ExpectedAttributeValue> expected)
|
void |
setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
void |
setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
void |
setKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
Set the hash and range key attributes of the item.
|
void |
setKey(Map<String,AttributeValue> key)
A map of attribute names to AttributeValue objects, representing
the primary key of the item to delete.
|
void |
setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) |
void |
setReturnConsumedCapacity(String returnConsumedCapacity) |
void |
setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
void |
setReturnItemCollectionMetrics(String returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
void |
setReturnValues(ReturnValue returnValues)
Use ReturnValues if you want to get the item attributes as they
appeared before they were deleted.
|
void |
setReturnValues(String returnValues)
Use ReturnValues if you want to get the item attributes as they
appeared before they were deleted.
|
void |
setTableName(String tableName)
The name of the table from which to delete the item.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DeleteItemRequest |
withConditionalOperator(ConditionalOperator conditionalOperator)
|
DeleteItemRequest |
withConditionalOperator(String conditionalOperator)
|
DeleteItemRequest |
withConditionExpression(String conditionExpression)
A condition that must be satisfied in order for a conditional
DeleteItem to succeed.
|
DeleteItemRequest |
withExpected(Map<String,ExpectedAttributeValue> expected)
|
DeleteItemRequest |
withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
DeleteItemRequest |
withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
DeleteItemRequest |
withKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
Set the hash and range key attributes of the item.
|
DeleteItemRequest |
withKey(Map<String,AttributeValue> key)
A map of attribute names to AttributeValue objects, representing
the primary key of the item to delete.
|
DeleteItemRequest |
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) |
DeleteItemRequest |
withReturnConsumedCapacity(String returnConsumedCapacity) |
DeleteItemRequest |
withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
DeleteItemRequest |
withReturnItemCollectionMetrics(String returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
DeleteItemRequest |
withReturnValues(ReturnValue returnValues)
Use ReturnValues if you want to get the item attributes as they
appeared before they were deleted.
|
DeleteItemRequest |
withReturnValues(String returnValues)
Use ReturnValues if you want to get the item attributes as they
appeared before they were deleted.
|
DeleteItemRequest |
withTableName(String tableName)
The name of the table from which to delete the item.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic DeleteItemRequest()
public DeleteItemRequest(String tableName, Map<String,AttributeValue> key)
tableName - The name of the table from which to delete the item.key - A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.
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.
public DeleteItemRequest(String tableName, Map<String,AttributeValue> key, String returnValues)
tableName - The name of the table from which to delete the item.key - A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.
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.
returnValues - Use ReturnValues if you want to get the item attributes as
they appeared before they were deleted. For DeleteItem, 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 - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB
operations; however, DeleteItem does not recognize any
values other than NONE or ALL_OLD.
public DeleteItemRequest(String tableName, Map<String,AttributeValue> key, ReturnValue returnValues)
tableName - The name of the table from which to delete the item.key - A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.
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.
returnValues - Use ReturnValues if you want to get the item attributes as
they appeared before they were deleted. For DeleteItem, 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 - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB
operations; however, DeleteItem does not recognize any
values other than NONE or ALL_OLD.
public void setTableName(String tableName)
The name of the table from which to delete the item.
tableName - The name of the table from which to delete the item.public String getTableName()
The name of the table from which to delete the item.
public DeleteItemRequest withTableName(String tableName)
The name of the table from which to delete the item.
tableName - The name of the table from which to delete the item.public Map<String,AttributeValue> getKey()
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
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.
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.
public void setKey(Map<String,AttributeValue> key)
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
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 - A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.
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.
public DeleteItemRequest withKey(Map<String,AttributeValue> key)
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
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 - A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.
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.
public DeleteItemRequest addKeyEntry(String key, AttributeValue value)
public DeleteItemRequest clearKeyEntries()
public Map<String,ExpectedAttributeValue> getExpected()
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - 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.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
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 datatypes,
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
datatypes, 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 datatypes, including lists and maps.
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 datatypes, including lists and maps.
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 within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the 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
condition evaluates to true; otherwise the condition evaluate to false.
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 condition evaluates
to true. If the value is found, despite the assumption that it does not
exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - 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.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
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
datatypes, 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
datatypes, 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 datatypes, including
lists and maps.
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 datatypes, including lists
and maps.
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 within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the 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 condition evaluates to true; otherwise the
condition evaluate to false.
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
condition evaluates to true. If the value is found, despite the
assumption that it does not exist, the condition evaluates to
false.
Note that the default value for Exists is
true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
public void setExpected(Map<String,ExpectedAttributeValue> expected)
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - 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.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
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 datatypes,
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
datatypes, 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 datatypes, including lists and maps.
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 datatypes, including lists and maps.
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 within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the 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
condition evaluates to true; otherwise the condition evaluate to false.
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 condition evaluates
to true. If the value is found, despite the assumption that it does not
exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
expected - This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - 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.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
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
datatypes, 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
datatypes, 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 datatypes, including
lists and maps.
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 datatypes, including lists
and maps.
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 within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the 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 condition evaluates to true; otherwise the
condition evaluate to false.
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
condition evaluates to true. If the value is found, despite the
assumption that it does not exist, the condition evaluates to
false.
Note that the default value for Exists is true
.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
public DeleteItemRequest withExpected(Map<String,ExpectedAttributeValue> expected)
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - 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.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
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 datatypes,
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
datatypes, 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 datatypes, including lists and maps.
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 datatypes, including lists and maps.
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 within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the 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
condition evaluates to true; otherwise the condition evaluate to false.
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 condition evaluates
to true. If the value is found, despite the assumption that it does not
exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
expected - This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - 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.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
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
datatypes, 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
datatypes, 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 datatypes, including
lists and maps.
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 datatypes, including lists
and maps.
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 within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the 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 condition evaluates to true; otherwise the
condition evaluate to false.
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
condition evaluates to true. If the value is found, despite the
assumption that it does not exist, the condition evaluates to
false.
Note that the default value for Exists is true
.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
public DeleteItemRequest addExpectedEntry(String key, ExpectedAttributeValue value)
public DeleteItemRequest clearExpectedEntries()
public void setConditionalOperator(String conditionalOperator)
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR - If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
conditionalOperator - This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then
the entire map evaluates to true.
OR - If at least one of the conditions evaluate to
true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
ConditionalOperatorpublic String getConditionalOperator()
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR - If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true,
then the entire map evaluates to true.
OR - If at least one of the conditions evaluate to
true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
ConditionalOperatorpublic DeleteItemRequest withConditionalOperator(String conditionalOperator)
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR - If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
conditionalOperator - This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then
the entire map evaluates to true.
OR - If at least one of the conditions evaluate to
true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
ConditionalOperatorpublic void setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR - If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
conditionalOperator - This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then
the entire map evaluates to true.
OR - If at least one of the conditions evaluate to
true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
ConditionalOperatorpublic DeleteItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR - If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
conditionalOperator - This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then
the entire map evaluates to true.
OR - If at least one of the conditions evaluate to
true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
ConditionalOperatorpublic void setReturnValues(String returnValues)
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, 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 - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB operations;
however, DeleteItem does not recognize any values other than
NONE or ALL_OLD.
returnValues - Use ReturnValues if you want to get the item attributes as
they appeared before they were deleted. For DeleteItem, 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 - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB
operations; however, DeleteItem does not recognize any
values other than NONE or ALL_OLD.
ReturnValuepublic String getReturnValues()
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, 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 - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB operations;
however, DeleteItem does not recognize any values other than
NONE or ALL_OLD.
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 - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB
operations; however, DeleteItem does not recognize any
values other than NONE or ALL_OLD.
ReturnValuepublic DeleteItemRequest withReturnValues(String returnValues)
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, 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 - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB operations;
however, DeleteItem does not recognize any values other than
NONE or ALL_OLD.
returnValues - Use ReturnValues if you want to get the item attributes as
they appeared before they were deleted. For DeleteItem, 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 - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB
operations; however, DeleteItem does not recognize any
values other than NONE or ALL_OLD.
ReturnValuepublic void setReturnValues(ReturnValue returnValues)
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, 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 - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB operations;
however, DeleteItem does not recognize any values other than
NONE or ALL_OLD.
returnValues - Use ReturnValues if you want to get the item attributes as
they appeared before they were deleted. For DeleteItem, 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 - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB
operations; however, DeleteItem does not recognize any
values other than NONE or ALL_OLD.
ReturnValuepublic DeleteItemRequest withReturnValues(ReturnValue returnValues)
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, 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 - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB operations;
however, DeleteItem does not recognize any values other than
NONE or ALL_OLD.
returnValues - Use ReturnValues if you want to get the item attributes as
they appeared before they were deleted. For DeleteItem, 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 - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB
operations; however, DeleteItem does not recognize any
values other than NONE or ALL_OLD.
ReturnValuepublic void setReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity - ReturnConsumedCapacitypublic String getReturnConsumedCapacity()
ReturnConsumedCapacitypublic DeleteItemRequest withReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity - ReturnConsumedCapacitypublic void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity - ReturnConsumedCapacitypublic DeleteItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity - ReturnConsumedCapacitypublic void setReturnItemCollectionMetrics(String returnItemCollectionMetrics)
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.
returnItemCollectionMetrics - 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.ReturnItemCollectionMetricspublic String getReturnItemCollectionMetrics()
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.
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.ReturnItemCollectionMetricspublic DeleteItemRequest withReturnItemCollectionMetrics(String returnItemCollectionMetrics)
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.
returnItemCollectionMetrics - 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.ReturnItemCollectionMetricspublic void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
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.
returnItemCollectionMetrics - 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.ReturnItemCollectionMetricspublic DeleteItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
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.
returnItemCollectionMetrics - 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.ReturnItemCollectionMetricspublic void setConditionExpression(String conditionExpression)
A condition that must be satisfied in order for a conditional DeleteItem 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 on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
conditionExpression - A condition that must be satisfied in order for a conditional
DeleteItem 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 on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
public String getConditionExpression()
A condition that must be satisfied in order for a conditional DeleteItem 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 on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
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 on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
public DeleteItemRequest withConditionExpression(String conditionExpression)
A condition that must be satisfied in order for a conditional DeleteItem 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 on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
conditionExpression - A condition that must be satisfied in order for a conditional
DeleteItem 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 on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
public Map<String,String> getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
expressionAttributeNames - One or more substitution tokens for attribute names in an
expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
expressionAttributeNames - One or more substitution tokens for attribute names in an
expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest addExpressionAttributeNamesEntry(String key, String value)
public DeleteItemRequest clearExpressionAttributeNamesEntries()
public Map<String,AttributeValue> getExpressionAttributeValues()
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 Specifying Conditions in the Amazon DynamoDB Developer Guide.
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 Specifying Conditions in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
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 Specifying Conditions in the Amazon DynamoDB Developer Guide.
expressionAttributeValues - 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 Specifying Conditions in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
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 Specifying Conditions in the Amazon DynamoDB Developer Guide.
expressionAttributeValues - 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 Specifying Conditions in the Amazon DynamoDB Developer Guide.
public DeleteItemRequest addExpressionAttributeValuesEntry(String key, AttributeValue value)
public DeleteItemRequest clearExpressionAttributeValuesEntries()
public void setKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
For a hash-only table, you only need to provide the hash attribute. For a hash-and-range table, you must provide both.
hashKey - a map entry including the name and value of the primary hash key.rangeKey - a map entry including the name and value of the primary range key,
or null if it is a hash-only table.IllegalArgumentExceptionpublic DeleteItemRequest withKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
For a hash-only table, you only need to provide the hash attribute. For a hash-and-range table, you must provide both.
Returns a reference to this object so that method calls can be chained together.
hashKey - a map entry including the name and value of the primary hash key.rangeKey - a map entry including the name and value of the primary range key,
or null if it is a hash-only table.IllegalArgumentExceptionpublic String toString()
toString in class ObjectObject.toString()public DeleteItemRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.