DynamoDB Put Item
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 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 attributes are the only required attributes. Attribute values cannot be null.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.
Invalid 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.
To learn more, visit the AWS documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| AWS Region(s) | Enter the desired AWS Region(s).To execute the action in multiple regions, provide a comma-separated list.For example: us-east-1,eu-west-2.If you wish to run the action in all available regions, use the asterisk symbol (*) instead. |
| 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.Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.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. |
| Table Name | The name of the table to contain the item. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Condition Expression | 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 | sizeThese function names are case-sensitive.- Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN |
- Logical operators:
AND \| OR \| NOTFor more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide. | | Conditional Operator | This is a legacy parameter. UseConditionExpressioninstead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. | | Disable XML To JSON Auto Convert | When checked, XML responses are not automatically converted into JSON format. | | Expected | This is a legacy parameter. UseConditionExpressioninstead. For more information, see Expected in the Amazon DynamoDB Developer Guide. | | Expression Attribute Names | One or more substitution tokens for attribute names in an expression. The following are some use cases for usingExpressionAttributeNames:- 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:-
PercentileThe 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 forExpressionAttributeNames:-{"#P":"Percentile"}You could then use this substitution in an expression, as in this example:-#P = :valTokens 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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide. | | Expression Attribute Values | 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 \| DiscontinuedYou would first need to specifyExpressionAttributeValuesas 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 Condition Expressions in the Amazon DynamoDB Developer Guide. | | Return Consumed Capacity | Determines the level of detail about provisioned throughput consumption that is returned in the response:-INDEXES- The response includes the aggregateConsumedCapacityfor the operation, together withConsumedCapacityfor each table and secondary index that was accessed.Note that some operations, such asGetItemandBatchGetItem, do not access any indexes at all. In these cases, specifyingINDEXESwill only returnConsumedCapacityinformation for table(s).-TOTAL- The response includes only the aggregateConsumedCapacityfor the operation. NONE- NoConsumedCapacitydetails are included in the response. | | Return Item Collection Metrics | Determines whether item collection metrics are returned. If set toSIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE(the default), no statistics are returned. | | Return Values | UseReturnValuesif you want to get the item attributes as they appeared before they were updated with thePutItemrequest. ForPutItem, the valid values are:-NONE- IfReturnValuesis not specified, or if its value isNONE, then nothing is returned. (This setting is the default forReturnValues.)ALL_OLD- IfPutItemoverwrote an attribute name-value pair, then the content of the old item is returned.TheReturnValuesparameter is used by several DynamoDB operations; however,PutItemdoes not recognize any values other thanNONEorALL_OLD. |
Example Output
Workflow Library Example
Dynamodb Put Item with Aws and Send Results Via Email
Preview this Workflow on desktop
Was this page helpful?