public class PutItemRequest extends AmazonWebServiceRequest implements java.io.Serializable
Creates a new item, or replaces an old item with a new item. If an item that
has the same primary key as the new item already exists in the specified
table, the new item completely replaces the existing item. You can perform a
conditional put operation (add a new item if one with the specified primary
key doesn't exist), or replace an existing item if it has certain attribute
values. You can return the item's attribute values in the same operation,
using the ReturnValues
parameter.
This topic provides general information about the PutItem
API.
For information on how to call the PutItem
API using the AWS SDK
in specific languages, see the following:
When you add an item, the primary key attribute(s) are the only required
attributes. Attribute values cannot be null. String and Binary type
attributes must have lengths greater than zero. Set type attributes cannot be
empty. Requests with empty values will be rejected with a
ValidationException
exception.
To prevent a new item from replacing an existing item, use a conditional
expression that contains the attribute_not_exists
function with
the name of the attribute being used as the partition key for the table.
Since every record must contain that attribute, the
attribute_not_exists
function will only succeed if no matching
item exists.
For more information about PutItem
, see Working with Items in the Amazon DynamoDB Developer Guide.
Constructor and Description |
---|
PutItemRequest()
Default constructor for PutItemRequest object.
|
PutItemRequest(java.lang.String tableName,
java.util.Map<java.lang.String,AttributeValue> item)
Constructs a new PutItemRequest object.
|
PutItemRequest(java.lang.String tableName,
java.util.Map<java.lang.String,AttributeValue> item,
ReturnValue returnValues)
Constructs a new PutItemRequest object.
|
PutItemRequest(java.lang.String tableName,
java.util.Map<java.lang.String,AttributeValue> item,
java.lang.String returnValues)
Constructs a new PutItemRequest object.
|
Modifier and Type | Method and Description |
---|---|
PutItemRequest |
addExpectedEntry(java.lang.String key,
ExpectedAttributeValue value)
This is a legacy parameter.
|
PutItemRequest |
addExpressionAttributeNamesEntry(java.lang.String key,
java.lang.String value)
One or more substitution tokens for attribute names in an expression.
|
PutItemRequest |
addExpressionAttributeValuesEntry(java.lang.String key,
AttributeValue value)
One or more values that can be substituted in an expression.
|
PutItemRequest |
addItemEntry(java.lang.String key,
AttributeValue value)
A map of attribute name/value pairs, one for each attribute.
|
PutItemRequest |
clearExpectedEntries()
Removes all the entries added into Expected.
|
PutItemRequest |
clearExpressionAttributeNamesEntries()
Removes all the entries added into ExpressionAttributeNames.
|
PutItemRequest |
clearExpressionAttributeValuesEntries()
Removes all the entries added into ExpressionAttributeValues.
|
PutItemRequest |
clearItemEntries()
Removes all the entries added into Item.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getConditionalOperator()
This is a legacy parameter.
|
java.lang.String |
getConditionExpression()
A condition that must be satisfied in order for a conditional
PutItem operation to succeed. |
java.util.Map<java.lang.String,ExpectedAttributeValue> |
getExpected()
This is a legacy parameter.
|
java.util.Map<java.lang.String,java.lang.String> |
getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression.
|
java.util.Map<java.lang.String,AttributeValue> |
getExpressionAttributeValues()
One or more values that can be substituted in an expression.
|
java.util.Map<java.lang.String,AttributeValue> |
getItem()
A map of attribute name/value pairs, one for each attribute.
|
java.lang.String |
getReturnConsumedCapacity()
Determines the level of detail about provisioned throughput consumption
that is returned in the response:
|
java.lang.String |
getReturnItemCollectionMetrics()
Determines whether item collection metrics are returned.
|
java.lang.String |
getReturnValues()
Use
ReturnValues if you want to get the item attributes as
they appeared before they were updated with the PutItem
request. |
java.lang.String |
getTableName()
The name of the table to contain the item.
|
int |
hashCode() |
void |
setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter.
|
void |
setConditionalOperator(java.lang.String conditionalOperator)
This is a legacy parameter.
|
void |
setConditionExpression(java.lang.String conditionExpression)
A condition that must be satisfied in order for a conditional
PutItem operation to succeed. |
void |
setExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
This is a legacy parameter.
|
void |
setExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
void |
setExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
void |
setItem(java.util.Map<java.lang.String,AttributeValue> item)
A map of attribute name/value pairs, one for each attribute.
|
void |
setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption
that is returned in the response:
|
void |
setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption
that is returned in the response:
|
void |
setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
void |
setReturnItemCollectionMetrics(java.lang.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 updated with the PutItem
request. |
void |
setReturnValues(java.lang.String returnValues)
Use
ReturnValues if you want to get the item attributes as
they appeared before they were updated with the PutItem
request. |
void |
setTableName(java.lang.String tableName)
The name of the table to contain the item.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
PutItemRequest |
withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter.
|
PutItemRequest |
withConditionalOperator(java.lang.String conditionalOperator)
This is a legacy parameter.
|
PutItemRequest |
withConditionExpression(java.lang.String conditionExpression)
A condition that must be satisfied in order for a conditional
PutItem operation to succeed. |
PutItemRequest |
withExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
This is a legacy parameter.
|
PutItemRequest |
withExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
PutItemRequest |
withExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
PutItemRequest |
withItem(java.util.Map<java.lang.String,AttributeValue> item)
A map of attribute name/value pairs, one for each attribute.
|
PutItemRequest |
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption
that is returned in the response:
|
PutItemRequest |
withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption
that is returned in the response:
|
PutItemRequest |
withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
PutItemRequest |
withReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
PutItemRequest |
withReturnValues(ReturnValue returnValues)
Use
ReturnValues if you want to get the item attributes as
they appeared before they were updated with the PutItem
request. |
PutItemRequest |
withReturnValues(java.lang.String returnValues)
Use
ReturnValues if you want to get the item attributes as
they appeared before they were updated with the PutItem
request. |
PutItemRequest |
withTableName(java.lang.String tableName)
The name of the table to contain the item.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public PutItemRequest()
public PutItemRequest(java.lang.String tableName, java.util.Map<java.lang.String,AttributeValue> item)
tableName
- The name of the table to contain the item.
item
- A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an
AttributeValue
object.
public PutItemRequest(java.lang.String tableName, java.util.Map<java.lang.String,AttributeValue> item, java.lang.String returnValues)
tableName
- The name of the table to contain the item.
item
- A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an
AttributeValue
object.
returnValues
-
Use ReturnValues
if you want to get the item
attributes as they appeared before they were updated with the
PutItem
request. For PutItem
, 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
- If PutItem
overwrote an
attribute name-value pair, then the content of the old item is
returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, PutItem
does not
recognize any values other than NONE
or
ALL_OLD
.
public PutItemRequest(java.lang.String tableName, java.util.Map<java.lang.String,AttributeValue> item, ReturnValue returnValues)
tableName
- The name of the table to contain the item.
item
- A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an
AttributeValue
object.
returnValues
-
Use ReturnValues
if you want to get the item
attributes as they appeared before they were updated with the
PutItem
request. For PutItem
, 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
- If PutItem
overwrote an
attribute name-value pair, then the content of the old item is
returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, PutItem
does not
recognize any values other than NONE
or
ALL_OLD
.
public java.lang.String getTableName()
The name of the table to contain the item.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
The name of the table to contain the item.
public void setTableName(java.lang.String tableName)
The name of the table to contain the item.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName
- The name of the table to contain the item.
public PutItemRequest withTableName(java.lang.String tableName)
The name of the table to contain the item.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName
- The name of the table to contain the item.
public java.util.Map<java.lang.String,AttributeValue> getItem()
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an
AttributeValue
object.
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an
AttributeValue
object.
public void setItem(java.util.Map<java.lang.String,AttributeValue> item)
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an
AttributeValue
object.
item
- A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an
AttributeValue
object.
public PutItemRequest withItem(java.util.Map<java.lang.String,AttributeValue> item)
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an
AttributeValue
object.
Returns a reference to this object so that method calls can be chained together.
item
- A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an
AttributeValue
object.
public PutItemRequest addItemEntry(java.lang.String key, AttributeValue value)
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an
AttributeValue
object.
The method adds a new key-value pair into Item parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into Item.value
- The corresponding value of the entry to be added into Item.public PutItemRequest clearItemEntries()
Returns a reference to this object so that method calls can be chained together.
public java.util.Map<java.lang.String,ExpectedAttributeValue> getExpected()
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see Expected in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
public void setExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see Expected in the Amazon DynamoDB Developer Guide.
expected
-
This is a legacy parameter. Use
ConditionExpression
instead. For more
information, see Expected in the Amazon DynamoDB Developer Guide.
public PutItemRequest withExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see Expected in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
expected
-
This is a legacy parameter. Use
ConditionExpression
instead. For more
information, see Expected in the Amazon DynamoDB Developer Guide.
public PutItemRequest addExpectedEntry(java.lang.String key, ExpectedAttributeValue value)
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see Expected in the Amazon DynamoDB Developer Guide.
The method adds a new key-value pair into Expected parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into Expected.value
- The corresponding value of the entry to be added into
Expected.public PutItemRequest clearExpectedEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.String getReturnValues()
Use ReturnValues
if you want to get the item attributes as
they appeared before they were updated with the PutItem
request. For PutItem
, 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
- If PutItem
overwrote an attribute
name-value pair, then the content of the old item is returned.
The ReturnValues
parameter is used by several DynamoDB
operations; however, PutItem
does not recognize any values
other than NONE
or ALL_OLD
.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
Use ReturnValues
if you want to get the item
attributes as they appeared before they were updated with the
PutItem
request. For PutItem
, 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
- If PutItem
overwrote an
attribute name-value pair, then the content of the old item is
returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, PutItem
does not
recognize any values other than NONE
or
ALL_OLD
.
ReturnValue
public void setReturnValues(java.lang.String returnValues)
Use ReturnValues
if you want to get the item attributes as
they appeared before they were updated with the PutItem
request. For PutItem
, 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
- If PutItem
overwrote an attribute
name-value pair, then the content of the old item is returned.
The ReturnValues
parameter is used by several DynamoDB
operations; however, PutItem
does not recognize any values
other than NONE
or ALL_OLD
.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
returnValues
-
Use ReturnValues
if you want to get the item
attributes as they appeared before they were updated with the
PutItem
request. For PutItem
, 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
- If PutItem
overwrote an
attribute name-value pair, then the content of the old item is
returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, PutItem
does not
recognize any values other than NONE
or
ALL_OLD
.
ReturnValue
public PutItemRequest withReturnValues(java.lang.String returnValues)
Use ReturnValues
if you want to get the item attributes as
they appeared before they were updated with the PutItem
request. For PutItem
, 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
- If PutItem
overwrote an attribute
name-value pair, then the content of the old item is returned.
The ReturnValues
parameter is used by several DynamoDB
operations; however, PutItem
does not recognize any values
other than NONE
or ALL_OLD
.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
returnValues
-
Use ReturnValues
if you want to get the item
attributes as they appeared before they were updated with the
PutItem
request. For PutItem
, 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
- If PutItem
overwrote an
attribute name-value pair, then the content of the old item is
returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, PutItem
does not
recognize any values other than NONE
or
ALL_OLD
.
ReturnValue
public void setReturnValues(ReturnValue returnValues)
Use ReturnValues
if you want to get the item attributes as
they appeared before they were updated with the PutItem
request. For PutItem
, 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
- If PutItem
overwrote an attribute
name-value pair, then the content of the old item is returned.
The ReturnValues
parameter is used by several DynamoDB
operations; however, PutItem
does not recognize any values
other than NONE
or ALL_OLD
.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
returnValues
-
Use ReturnValues
if you want to get the item
attributes as they appeared before they were updated with the
PutItem
request. For PutItem
, 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
- If PutItem
overwrote an
attribute name-value pair, then the content of the old item is
returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, PutItem
does not
recognize any values other than NONE
or
ALL_OLD
.
ReturnValue
public PutItemRequest withReturnValues(ReturnValue returnValues)
Use ReturnValues
if you want to get the item attributes as
they appeared before they were updated with the PutItem
request. For PutItem
, 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
- If PutItem
overwrote an attribute
name-value pair, then the content of the old item is returned.
The ReturnValues
parameter is used by several DynamoDB
operations; however, PutItem
does not recognize any values
other than NONE
or ALL_OLD
.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
returnValues
-
Use ReturnValues
if you want to get the item
attributes as they appeared before they were updated with the
PutItem
request. For PutItem
, 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
- If PutItem
overwrote an
attribute name-value pair, then the content of the old item is
returned.
The ReturnValues
parameter is used by several
DynamoDB operations; however, PutItem
does not
recognize any values other than NONE
or
ALL_OLD
.
ReturnValue
public java.lang.String getReturnConsumedCapacity()
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary index that was
accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all. In these
cases, specifying INDEXES
will only return
ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details are included
in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary index
that was accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all. In
these cases, specifying INDEXES
will only return
ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details are
included in the response.
ReturnConsumedCapacity
public void setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary index that was
accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all. In these
cases, specifying INDEXES
will only return
ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details are included
in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary
index that was accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all.
In these cases, specifying INDEXES
will only
return ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details
are included in the response.
ReturnConsumedCapacity
public PutItemRequest withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary index that was
accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all. In these
cases, specifying INDEXES
will only return
ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details are included
in the response.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary
index that was accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all.
In these cases, specifying INDEXES
will only
return ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details
are included in the response.
ReturnConsumedCapacity
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary index that was
accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all. In these
cases, specifying INDEXES
will only return
ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details are included
in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary
index that was accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all.
In these cases, specifying INDEXES
will only
return ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details
are included in the response.
ReturnConsumedCapacity
public PutItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary index that was
accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all. In these
cases, specifying INDEXES
will only return
ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details are included
in the response.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregate
ConsumedCapacity
for the operation, together with
ConsumedCapacity
for each table and secondary
index that was accessed.
Note that some operations, such as GetItem
and
BatchGetItem
, do not access any indexes at all.
In these cases, specifying INDEXES
will only
return ConsumedCapacity
information for table(s).
TOTAL
- The response includes only the aggregate
ConsumedCapacity
for the operation.
NONE
- No ConsumedCapacity
details
are included in the response.
ReturnConsumedCapacity
public java.lang.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.
Constraints:
Allowed Values: SIZE, NONE
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
public void setReturnItemCollectionMetrics(java.lang.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.
Constraints:
Allowed Values: SIZE, NONE
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
public PutItemRequest withReturnItemCollectionMetrics(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SIZE, NONE
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
public 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.
Constraints:
Allowed Values: SIZE, NONE
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
public PutItemRequest 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SIZE, NONE
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
public java.lang.String getConditionalOperator()
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Constraints:
Allowed Values: AND, OR
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer
Guide.
ConditionalOperator
public void setConditionalOperator(java.lang.String conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Constraints:
Allowed Values: AND, OR
conditionalOperator
-
This is a legacy parameter. Use
ConditionExpression
instead. For more
information, see ConditionalOperator in the Amazon DynamoDB Developer
Guide.
ConditionalOperator
public PutItemRequest withConditionalOperator(java.lang.String conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
conditionalOperator
-
This is a legacy parameter. Use
ConditionExpression
instead. For more
information, see ConditionalOperator in the Amazon DynamoDB Developer
Guide.
ConditionalOperator
public void setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Constraints:
Allowed Values: AND, OR
conditionalOperator
-
This is a legacy parameter. Use
ConditionExpression
instead. For more
information, see ConditionalOperator in the Amazon DynamoDB Developer
Guide.
ConditionalOperator
public PutItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead.
For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
conditionalOperator
-
This is a legacy parameter. Use
ConditionExpression
instead. For more
information, see ConditionalOperator in the Amazon DynamoDB Developer
Guide.
ConditionalOperator
public java.lang.String getConditionExpression()
A condition that must be satisfied in order for a conditional
PutItem
operation 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.
A condition that must be satisfied in order for a conditional
PutItem
operation 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.
public void setConditionExpression(java.lang.String conditionExpression)
A condition that must be satisfied in order for a conditional
PutItem
operation 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
-
A condition that must be satisfied in order for a conditional
PutItem
operation 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.
public PutItemRequest withConditionExpression(java.lang.String conditionExpression)
A condition that must be satisfied in order for a conditional
PutItem
operation 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.
Returns a reference to this object so that method calls can be chained together.
conditionExpression
-
A condition that must be satisfied in order for a conditional
PutItem
operation 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.
public java.util.Map<java.lang.String,java.lang.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.
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 void setExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.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 PutItemRequest withExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 PutItemRequest addExpressionAttributeNamesEntry(java.lang.String key, java.lang.String value)
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.
The method adds a new key-value pair into ExpressionAttributeNames parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into
ExpressionAttributeNames.value
- The corresponding value of the entry to be added into
ExpressionAttributeNames.public PutItemRequest clearExpressionAttributeNamesEntries()
Returns a reference to this object so that method calls can be chained together.
public java.util.Map<java.lang.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.
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 void setExpressionAttributeValues(java.util.Map<java.lang.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 PutItemRequest withExpressionAttributeValues(java.util.Map<java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 PutItemRequest addExpressionAttributeValuesEntry(java.lang.String key, AttributeValue value)
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.
The method adds a new key-value pair into ExpressionAttributeValues parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into
ExpressionAttributeValues.value
- The corresponding value of the entry to be added into
ExpressionAttributeValues.public PutItemRequest clearExpressionAttributeValuesEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.