Creates a new item, or replaces an old item with a new item. If an item already exists in the specified table with the same primary key, the new item completely replaces the existing item. You can perform a conditional put (insert a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values.
In addition to putting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.
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 .
You can request that PutItem return either a copy of the old item (before the update) or a copy of the new item (after the update). For more information, see the ReturnValues description.
NOTE: To prevent a new item from replacing an existing item, use a conditional put operation with Exists set to false for the primary key attribute, or attributes.
For more information about using this API, see Working with Items in the Amazon DynamoDB Developer Guide.

C# |
public class PutItemRequest : AmazonWebServiceRequest

All Members | Constructors | Methods | Properties | ||
Icon | Member | Description |
---|---|---|
![]() | PutItemRequest()()()() | Initializes a new instance of the PutItemRequest class |
![]() | ConditionalOperator |
A logical operator to apply to the conditions in the Expected map:
Constraints: |
![]() | Equals(Object) | (Inherited from Object.) |
![]() | Expected |
A map of attribute/condition pairs. This is the conditional block for the PutItem operation. Expected allows you to provide an
attribute name, and whether or not DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and
has a particular value before changing it. Each item in Expected represents an attribute name for DynamoDB to check, along with the
following:
|
![]() | GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType()()()() | Gets the type of the current instance. (Inherited from 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. 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.
|
![]() | ReturnConsumedCapacity |
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response
includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
Constraints: |
![]() | ReturnItemCollectionMetrics |
If set to SIZE, 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: |
![]() | 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:
Constraints: |
![]() | TableName |
The name of the table to contain the item.
Constraints: |
![]() | ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
![]() | WithConditionalOperator(String) | Obsolete.
Sets the ConditionalOperator property
|
![]() | WithExpected(array<KeyValuePair<(Of <<'(String, ExpectedAttributeValue>)>>)>[]()[][]) | Obsolete.
Adds the KeyValuePairs to the Expected dictionary.
|
![]() | WithItem(array<KeyValuePair<(Of <<'(String, AttributeValue>)>>)>[]()[][]) | Obsolete.
Adds the KeyValuePairs to the Item dictionary.
|
![]() | WithReturnConsumedCapacity(String) | Obsolete.
Sets the ReturnConsumedCapacity property
|
![]() | WithReturnItemCollectionMetrics(String) | Obsolete.
Sets the ReturnItemCollectionMetrics property
|
![]() | WithReturnValues(String) | Obsolete.
Sets the ReturnValues property
|
![]() | WithTableName(String) | Obsolete.
Sets the TableName property
|

This example shows how to put an item in a table.

// Create a client AmazonDynamoDBClient client = new AmazonDynamoDBClient(); // Define item attributes Dictionary<string, AttributeValue> attributes = new Dictionary<string, AttributeValue>(); // Author is hash-key attributes["Author"] = new AttributeValue { S = "Mark Twain" }; // Title is range-key attributes["Title"] = new AttributeValue { S = "The Adventures of Tom Sawyer" }; // Other attributes attributes["Year"] = new AttributeValue { N = "1876" }; attributes["Setting"] = new AttributeValue { S = "Missouri" }; attributes["Pages"] = new AttributeValue { N = "275" }; attributes["Genres"] = new AttributeValue { SS = new List<string> { "Satire", "Folk", "Children's Novel" } }; // Create PutItem request PutItemRequest request = new PutItemRequest { TableName = "SampleTable", Item = attributes }; // Issue PutItem request client.PutItem(request);

Object | ||
![]() | AmazonWebServiceRequest | |
![]() | PutItemRequest |
