IAmazonDynamoDB.PutItem Method (PutItemRequest)

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.

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 exception.

You can request that PutItem return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the ReturnValues description below.

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 using this API, see Working with Items in the Amazon DynamoDB Developer Guide.

Namespace: Amazon.DynamoDBv2
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

public abstract PutItemResponse PutItem(
         PutItemRequest request
)

Parameters

request: Type: Amazon.DynamoDBv2.Model.PutItemRequest

Container for the necessary parameters to execute the PutItem service method.

Return Value

Type: Amazon.DynamoDBv2.Model.PutItemResponse
The response from the PutItem service method, as returned by DynamoDB.

Exceptions

Exception	Condition
ConditionalCheckFailedException	A condition specified in the operation could not be evaluated.
InternalServerErrorException	An error occurred on the server side.
ItemCollectionSizeLimitExceededException	An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
ProvisionedThroughputExceededException	Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
ResourceNotFoundException	The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

Examples

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

PutItem sample


// 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);

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5