AWS SDK for .NET Documentation
PutItemRequest Class
AmazonAmazon.DynamoDBv2.ModelPutItemRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the PutItem operation.

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.

Declaration Syntax
C#
public class PutItemRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
PutItemRequest()()()()
Initializes a new instance of the PutItemRequest class

ConditionalOperator
A logical operator to apply to the conditions in the Expected map:
  • AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
  • OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is used as the default. The operation will succeed only if the entire map evaluates to true.

Constraints:

Allowed Values
AND, OR


Equals(Object)
Determines whether the specified Object is equal to the current 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:
  • Value - A value for DynamoDB to compare with an attribute. When performing the comparison, strongly consistent reads are used.
  • Exists - Causes DynamoDB to evaluate the value before attempting a conditional operation:
    • If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException.
    • If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException.
    The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied. DynamoDB returns a ValidationException if:
    • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)
    • Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)
If you specify more than one condition in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) If Expected evaluates to true, then the conditional operation succeeds; otherwise, it fails.

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:

Allowed Values
INDEXES, TOTAL, NONE


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:

Allowed Values
SIZE, NONE


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 is the default for ReturnValues.)
  • ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

Constraints:

Allowed Values
NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW


TableName
The name of the table to contain the item.

Constraints:

Length
3 - 255
Pattern
[a-zA-Z0-9_.-]+


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

Examples

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

CopyPutItem 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);
Inheritance Hierarchy
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)