PutItemRequest Class | AWS SDK for .NET V3

Container for the parameters to the PutItem operation. 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 ReturnValues parameter.

When you add an item, the primary key attributes are the only required attributes.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DynamoDBv2.AmazonDynamoDBRequest
      Amazon.DynamoDBv2.Model.PutItemRequest

Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

public class PutItemRequest : AmazonDynamoDBRequest
         IAmazonWebServiceRequest

The PutItemRequest type exposes the following members

Constructors

	Name	Description
	PutItemRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	PutItemRequest(string, Dictionary<String, AttributeValue>)	Instantiates PutItemRequest with the parameterized properties
	PutItemRequest(string, Dictionary<String, AttributeValue>, ReturnValue)	Instantiates PutItemRequest with the parameterized properties

Properties

Name	Type	Description
ConditionalOperator	Amazon.DynamoDBv2.ConditionalOperator	Gets and sets the property ConditionalOperator. This is a legacy parameter. Use `ConditionExpression` instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
ConditionExpression	System.String	Gets and sets the property ConditionExpression. 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 \| size` These function names are case-sensitive. Comparison operators: `= \| <> \| < \| > \| <= \| >= \| BETWEEN \| IN` Logical operators: `AND \| OR \| NOT` For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
Expected	System.Collections.Generic.Dictionary<System.String, Amazon.DynamoDBv2.Model.ExpectedAttributeValue>	Gets and sets the property Expected. This is a legacy parameter. Use `ConditionExpression` instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
ExpressionAttributeNames	System.Collections.Generic.Dictionary<System.String, System.String>	Gets and sets the property ExpressionAttributeNames. One or more substitution tokens for attribute names in an expression. The following are some use cases for using `ExpressionAttributeNames`: 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: `Percentile` The 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 for `ExpressionAttributeNames`: `{"#P":"Percentile"}` You could then use this substitution in an expression, as in this example: `#P = :val` Tokens 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.
ExpressionAttributeValues	System.Collections.Generic.Dictionary<System.String, Amazon.DynamoDBv2.Model.AttributeValue>	Gets and sets the property ExpressionAttributeValues. 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 \| Discontinued` You would first need to specify `ExpressionAttributeValues` as 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.
Item	System.Collections.Generic.Dictionary<System.String, Amazon.DynamoDBv2.Model.AttributeValue>	Gets and sets the property 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.
ReturnConsumedCapacity	Amazon.DynamoDBv2.ReturnConsumedCapacity	Gets and sets the property ReturnConsumedCapacity.
ReturnItemCollectionMetrics	Amazon.DynamoDBv2.ReturnItemCollectionMetrics	Gets and sets the property ReturnItemCollectionMetrics. Determines whether item collection metrics are returned. If set to `SIZE`, the response includes 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.
ReturnValues	Amazon.DynamoDBv2.ReturnValue	Gets and sets the property 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 setting is the default for `ReturnValues`.) `ALL_OLD` - If `PutItem` overwrote an attribute name-value pair, then the content of the old item is returned. The values returned are strongly consistent. There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed. The `ReturnValues` parameter is used by several DynamoDB operations; however, `PutItem` does not recognize any values other than `NONE` or `ALL_OLD`.
ReturnValuesOnConditionCheckFailure	Amazon.DynamoDBv2.ReturnValuesOnConditionCheckFailure	Gets and sets the property ReturnValuesOnConditionCheckFailure. An optional parameter that returns the item attributes for a `PutItem` operation that failed a condition check. There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
TableName	System.String	Gets and sets the property TableName. The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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