class Aws::DynamoDB::Types::PutItemInput

@see docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/PutItemInput AWS API Documentation
@return [String]
receiving a larger response. No read capacity units are consumed.
value aside from the small network and processing overhead of
There is no additional cost associated with requesting a return
`PutItem` operation that failed a condition check.
An optional parameter that returns the item attributes for a
@!attribute [rw] return_values_on_condition_check_failure
@return [Hash<String,Types::AttributeValue>] : docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html Expressions][1] in the *Amazon DynamoDB Developer Guide*.
For more information on expression attribute values, see [Condition
`ProductStatus IN (:avail, :back, :disc)‘
You could then use these values in an expression, such as this:
“:disc”:{“S”:“Discontinued”} }`
`{ “:avail”:{“S”:“Available”}, “:back”:{“S”:“Backordered”},
follows:
You would first need to specify `ExpressionAttributeValues` as
`Available | Backordered | Discontinued`
following:
whether the value of the ProductStatus attribute was one of the
attribute value. For example, suppose that you wanted to check
Use the : (colon) character in an expression to dereference an
One or more values that can be substituted in an expression.
@!attribute [rw] expression_attribute_values
@return [Hash<String,String>] : docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html [1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html Item Attributes] in the *Amazon DynamoDB Developer Guide*.
For more information on expression attribute names, see [Specifying
</note>
runtime.
attribute values*, which are placeholders for the actual value at
<note markdown=“1”> Tokens that begin with the : character are *expression
^
* `#P = :val`
example:
You could then use this substitution in an expression, as in this
^
* `{“#P”:“Percentile”}`
following for `ExpressionAttributeNames`:
Developer Guide*). To work around this, you could specify the
reserved words, see [Reserved Words] in the *Amazon DynamoDB
cannot be used directly in an expression. (For the complete list of
The name of this attribute conflicts with a reserved word, so it
^
* `Percentile`
name. For example, consider the following attribute name:
Use the **#** character in an expression to dereference an attribute
misinterpreted in an expression.
* To prevent special characters in an attribute name from being
name in an expression.
* To create a placeholder for repeating occurrences of an attribute
reserved word.
* To access an attribute whose name conflicts with a DynamoDB
`ExpressionAttributeNames`:
expression. The following are some use cases for using
One or more substitution tokens for attribute names in an
@!attribute [rw] expression_attribute_names
@return [String] : docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html Expressions][1] in the *Amazon DynamoDB Developer Guide*.
For more information on condition expressions, see [Condition
* Logical operators: `AND | OR | NOT`
* Comparison operators: `= | <> | < | > | <= | >= | BETWEEN | IN `
These function names are case-sensitive.
attribute_type | contains | begins_with | size`
* Functions: `attribute_exists | attribute_not_exists |
An expression can contain any of the following:
`PutItem` operation to succeed.
A condition that must be satisfied in order for a conditional
@!attribute [rw] condition_expression
@return [String] : docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html DynamoDB Developer Guide*.
more information, see [ConditionalOperator] in the *Amazon
This is a legacy parameter. Use `ConditionExpression` instead. For
@!attribute [rw] conditional_operator
@return [String]
returned.
response. If set to `NONE` (the default), no statistics are
any, that were modified during the operation are returned in the
`SIZE`, the response includes statistics about item collections, if
Determines whether item collection metrics are returned. If set to
@!attribute [rw] return_item_collection_metrics
@return [String]
response.
* `NONE` - No `ConsumedCapacity` details are included in the
`ConsumedCapacity` for the operation.
* `TOTAL` - The response includes only the aggregate
table(s).
`INDEXES` will only return `ConsumedCapacity` information for
do not access any indexes at all. In these cases, specifying
Note that some operations, such as `GetItem` and `BatchGetItem`,
and secondary index that was accessed.
for the operation, together with `ConsumedCapacity` for each table
* `INDEXES` - The response includes the aggregate `ConsumedCapacity`
throughput consumption that is returned in the response:
Determines the level of detail about either provisioned or on-demand
@!attribute [rw] return_consumed_capacity
@return [String]
</note>
or `ALL_OLD`.
however, `PutItem` does not recognize any values other than `NONE`
<note markdown=“1”> The `ReturnValues` parameter is used by several DynamoDB operations;
receiving a larger response. No read capacity units are consumed.
value aside from the small network and processing overhead of
There is no additional cost associated with requesting a return
The values returned are strongly consistent.
then the content of the old item is returned.
* `ALL_OLD` - If `PutItem` overwrote an attribute name-value pair,
`ReturnValues`.)
`NONE`, then nothing is returned. (This setting is the default for
* `NONE` - If `ReturnValues` is not specified, or if its value is
`PutItem`, the valid values are:
appeared before they were updated with the `PutItem` request. For
Use `ReturnValues` if you want to get the item attributes as they
@!attribute [rw] return_values
@return [Hash<String,Types::ExpectedAttributeValue>] : docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html Developer Guide*.
more information, see [Expected] in the *Amazon DynamoDB
This is a legacy parameter. Use `ConditionExpression` instead. For
@!attribute [rw] expected
@return [Hash<String,Types::AttributeValue>] : docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey Each element in the `Item` map is an `AttributeValue` object.
*Amazon DynamoDB Developer Guide*.
For more information about primary keys, see [Primary Key] in the
index.
zero if the attribute is used as a key attribute for a table or
values of type String and Binary must have a length greater than
Empty String and Binary attribute values are allowed. Attribute
in the table’s attribute definition.
the data types for those attributes must match those of the schema
If you specify any attributes that are part of an index key, then
both values for both the partition key and the sort key.
for the partition key. For a composite primary key, you must provide
example, with a simple primary key, you only need to provide a value
You must provide all of the attributes for the primary key. For
other attribute name-value pairs for the item.
the primary key attributes are required; you can optionally provide
A map of attribute name/value pairs, one for each attribute. Only
@!attribute [rw] item
@return [String]
The name of the table to contain the item.
@!attribute [rw] table_name
Represents the input of a ‘PutItem` operation.

class Aws::DynamoDB::Types::PutItemInput

Namespace

Included Modules

Defined in