class Aws::DynamoDB::Types::Condition

@see docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/Condition AWS API Documentation
@return [String] : docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html Developer Guide*.
see [Legacy Conditional Parameters] in the *Amazon DynamoDB
For usage examples of ‘AttributeValueList` and `ComparisonOperator`,
“2”, “1”]}`
`{“N”:“6”}`. Also, `{“N”:“6”}` does not compare to `{“NS”:[“6”,
does not match. For example, `{“S”:“6”}` does not compare to
different type than the one provided in the request, the value
element. If an item contains an `AttributeValue` element of a
equal to, the first element and less than, or equal to, the second
A target attribute matches if the target value is greater than, or
the same type, either String, Number, or Binary (not a set type).
`AttributeValueList` must contain two `AttributeValue` elements of
than or equal to the second value.
* `BETWEEN` : Greater than or equal to the first value, and less
evaluates to true.
of the input are equal to the item attribute, the expression
compared against an existing attribute of an item. If any elements
elements of type String, Number, or Binary. These attributes are
`AttributeValueList` can contain one or more `AttributeValue`
* `IN` : Checks for matching elements in a list.
a Number or a set type).
attribute of the comparison must be of type String or Binary (not
String or Binary (not a Number or a set type). The target
`AttributeValueList` can contain only one `AttributeValue` of type
* `BEGINS_WITH` : Checks for a prefix.
set, a map, or a list.
CONTAINS b`“, ”`a`“ can be a list; however, ”`b`“ cannot be a
NOT_CONTAINS is supported for lists: When evaluating ”`a NOT
find an exact match with any member of the set.
or “`BS`”), then the operator evaluates to true if it *does not*
target attribute of the comparison is a set (“`SS`”, “`NS`”,
of a subsequence of the target that matches the input. If the
the comparison is Binary, then the operator checks for the absence
for the absence of a substring match. If the target attribute of
attribute of the comparison is a String, then the operator checks
of type String, Number, or Binary (not a set type). If the target
`AttributeValueList` can contain only one `AttributeValue` element
of a value in a set.
* `NOT_CONTAINS` : Checks for absence of a subsequence, or absence
map, or a list.
b`“, ”`a`“ can be a list; however, ”`b`“ cannot be a set, a
CONTAINS is supported for lists: When evaluating ”`a CONTAINS
exact match with any member of the set.
“`BS`”), then the operator evaluates to true if it finds an
attribute of the comparison is a set (“`SS`”, “`NS`”, or
subsequence of the target that matches the input. If the target
comparison is of type Binary, then the operator looks for a
checks for a substring match. If the target attribute of the
attribute of the comparison is of type String, then the operator
of type String, Number, or Binary (not a set type). If the target
`AttributeValueList` can contain only one `AttributeValue` element
* `CONTAINS` : Checks for a subsequence, or value in a set.
</note>
relevant to the `NULL` comparison operator.
because the attribute “`a`” exists; its data type is not
evaluate it using `NULL`, the result is a Boolean `false`. This is
data type. If the data type of attribute “`a`” is null, and you
<note markdown=“1”> This operator tests for the nonexistence of an attribute, not its
data types, including lists and maps.
* `NULL` : The attribute does not exist. `NULL` is supported for all
</note>
not relevant to the `NOT_NULL` comparison operator.
result is because the attribute “`a`” exists; its data type is
evaluate it using `NOT_NULL`, the result is a Boolean `true`. This
data type. If the data type of attribute “`a`” is null, and you
<note markdown=“1”> This operator tests for the existence of an attribute, not its
data types, including lists and maps.
* `NOT_NULL` : The attribute exists. `NOT_NULL` is supported for all
does not compare to `{“NS”:[“6”, “2”, “1”]}`.
example, `{“S”:“6”}` does not equal `{“N”:“6”}`. Also, `{“N”:“6”}`
one provided in the request, the value does not match. For
contains an `AttributeValue` element of a different type than the
of type String, Number, or Binary (not a set type). If an item
`AttributeValueList` can contain only one `AttributeValue` element
* `GT` : Greater than.
does not compare to `{“NS”:[“6”, “2”, “1”]}`.
example, `{“S”:“6”}` does not equal `{“N”:“6”}`. Also, `{“N”:“6”}`
one provided in the request, the value does not match. For
contains an `AttributeValue` element of a different type than the
of type String, Number, or Binary (not a set type). If an item
`AttributeValueList` can contain only one `AttributeValue` element
* `GE` : Greater than or equal.
`{“NS”:[“6”, “2”, “1”]}`.
does not equal `{“N”:“6”}`. Also, `{“N”:“6”}` does not compare to
in the request, the value does not match. For example, `{“S”:“6”}`
`AttributeValue` element of a different type than the one provided
String, Number, or Binary (not a set type). If an item contains an
`AttributeValueList` can contain only one `AttributeValue` of type
* `LT` : Less than.
does not compare to `{“NS”:[“6”, “2”, “1”]}`.
example, `{“S”:“6”}` does not equal `{“N”:“6”}`. Also, `{“N”:“6”}`
one provided in the request, the value does not match. For
contains an `AttributeValue` element of a different type than the
of type String, Number, or Binary (not a set type). If an item
`AttributeValueList` can contain only one `AttributeValue` element
* `LE` : Less than or equal.
does not equal `{“NS”:[“6”, “2”, “1”]}`.
example, `{“S”:“6”}` does not equal `{“N”:“6”}`. Also, `{“N”:“6”}`
one provided in the request, the value does not match. For
an item contains an `AttributeValue` of a different type than the
String, Number, Binary, String Set, Number Set, or Binary Set. If
`AttributeValueList` can contain only one `AttributeValue` of type
lists and maps.
* `NE` : Not equal. `NE` is supported for all data types, including
“1”]}`.
`{“N”:“6”}`. Also, `{“N”:“6”}` does not equal `{“NS”:[“6”, “2”,
does not match. For example, `{“S”:“6”}` does not equal
different type than the one provided in the request, the value
Set. If an item contains an `AttributeValue` element of a
of type String, Number, Binary, String Set, Number Set, or Binary
`AttributeValueList` can contain only one `AttributeValue` element
lists and maps.
* `EQ` : Equal. `EQ` is supported for all data types, including
The following are descriptions of each comparison operator.
NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN`
`EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS |
The following comparison operators are available:
than, less than, etc.
A comparator for evaluating attributes. For example, equals, greater
@!attribute [rw] comparison_operator
@return [Array<Types::AttributeValue>] : en.wikipedia.org/wiki/ASCII#ASCII_printable_characters when it compares binary values.
For Binary, DynamoDB treats each byte of the binary data as unsigned [1].
see
than `A`, and `a` is greater than `B`. For a list of code values,
based on ASCII character code values. For example, `a` is greater
String value comparisons for greater than, equals, or less than are
For type Number, value comparisons are numeric.
being used.
number of values in the list depends on the `ComparisonOperator`
One or more values to evaluate against the supplied attribute. The
@!attribute [rw] attribute_value_list
evaluates the scan results and returns only the desired values.
* For a `Scan` operation, `Condition` is used in a `ScanFilter`, which
query results and returns only the desired values.
`Condition` is also used in a `QueryFilter`, which evaluates the
`EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN`
supported:
`KeyConditions`, only the following comparison operators are
`KeyConditions` to use when querying a table or an index. For
* For a `Query` operation, `Condition` is used for specifying the
Represents the selection criteria for a `Query` or `Scan` operation:

class Aws::DynamoDB::Types::Condition

Namespace

Included Modules

Defined in