Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

PutItemCommand

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DynamoDBClient, PutItemCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, PutItemCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // PutItemInput
  TableName: "STRING_VALUE", // required
  Item: { // PutItemInputAttributeMap // required
    "<keys>": { // AttributeValue Union: only one key present
      S: "STRING_VALUE",
      N: "STRING_VALUE",
      B: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
      SS: [ // StringSetAttributeValue
        "STRING_VALUE",
      ],
      NS: [ // NumberSetAttributeValue
        "STRING_VALUE",
      ],
      BS: [ // BinarySetAttributeValue
        new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
      ],
      M: { // MapAttributeValue
        "<keys>": {//  Union: only one key present
          S: "STRING_VALUE",
          N: "STRING_VALUE",
          B: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
          SS: [
            "STRING_VALUE",
          ],
          NS: [
            "STRING_VALUE",
          ],
          BS: [
            new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
          ],
          M: {
            "<keys>": "<AttributeValue>",
          },
          L: [ // ListAttributeValue
            "<AttributeValue>",
          ],
          NULL: true || false,
          BOOL: true || false,
        },
      },
      L: [
        "<AttributeValue>",
      ],
      NULL: true || false,
      BOOL: true || false,
    },
  },
  Expected: { // ExpectedAttributeMap
    "<keys>": { // ExpectedAttributeValue
      Value: "<AttributeValue>",
      Exists: true || false,
      ComparisonOperator: "EQ" || "NE" || "IN" || "LE" || "LT" || "GE" || "GT" || "BETWEEN" || "NOT_NULL" || "NULL" || "CONTAINS" || "NOT_CONTAINS" || "BEGINS_WITH",
      AttributeValueList: [ // AttributeValueList
        "<AttributeValue>",
      ],
    },
  },
  ReturnValues: "NONE" || "ALL_OLD" || "UPDATED_OLD" || "ALL_NEW" || "UPDATED_NEW",
  ReturnConsumedCapacity: "INDEXES" || "TOTAL" || "NONE",
  ReturnItemCollectionMetrics: "SIZE" || "NONE",
  ConditionalOperator: "AND" || "OR",
  ConditionExpression: "STRING_VALUE",
  ExpressionAttributeNames: { // ExpressionAttributeNameMap
    "<keys>": "STRING_VALUE",
  },
  ExpressionAttributeValues: { // ExpressionAttributeValueMap
    "<keys>": "<AttributeValue>",
  },
  ReturnValuesOnConditionCheckFailure: "ALL_OLD" || "NONE",
};
const command = new PutItemCommand(input);
const response = await client.send(command);
// { // PutItemOutput
//   Attributes: { // AttributeMap
//     "<keys>": { // AttributeValue Union: only one key present
//       S: "STRING_VALUE",
//       N: "STRING_VALUE",
//       B: new Uint8Array(),
//       SS: [ // StringSetAttributeValue
//         "STRING_VALUE",
//       ],
//       NS: [ // NumberSetAttributeValue
//         "STRING_VALUE",
//       ],
//       BS: [ // BinarySetAttributeValue
//         new Uint8Array(),
//       ],
//       M: { // MapAttributeValue
//         "<keys>": {//  Union: only one key present
//           S: "STRING_VALUE",
//           N: "STRING_VALUE",
//           B: new Uint8Array(),
//           SS: [
//             "STRING_VALUE",
//           ],
//           NS: [
//             "STRING_VALUE",
//           ],
//           BS: [
//             new Uint8Array(),
//           ],
//           M: {
//             "<keys>": "<AttributeValue>",
//           },
//           L: [ // ListAttributeValue
//             "<AttributeValue>",
//           ],
//           NULL: true || false,
//           BOOL: true || false,
//         },
//       },
//       L: [
//         "<AttributeValue>",
//       ],
//       NULL: true || false,
//       BOOL: true || false,
//     },
//   },
//   ConsumedCapacity: { // ConsumedCapacity
//     TableName: "STRING_VALUE",
//     CapacityUnits: Number("double"),
//     ReadCapacityUnits: Number("double"),
//     WriteCapacityUnits: Number("double"),
//     Table: { // Capacity
//       ReadCapacityUnits: Number("double"),
//       WriteCapacityUnits: Number("double"),
//       CapacityUnits: Number("double"),
//     },
//     LocalSecondaryIndexes: { // SecondaryIndexesCapacityMap
//       "<keys>": {
//         ReadCapacityUnits: Number("double"),
//         WriteCapacityUnits: Number("double"),
//         CapacityUnits: Number("double"),
//       },
//     },
//     GlobalSecondaryIndexes: {
//       "<keys>": {
//         ReadCapacityUnits: Number("double"),
//         WriteCapacityUnits: Number("double"),
//         CapacityUnits: Number("double"),
//       },
//     },
//   },
//   ItemCollectionMetrics: { // ItemCollectionMetrics
//     ItemCollectionKey: { // ItemCollectionKeyAttributeMap
//       "<keys>": "<AttributeValue>",
//     },
//     SizeEstimateRangeGB: [ // ItemCollectionSizeEstimateRange
//       Number("double"),
//     ],
//   },
// };

Example Usage

Loading code editorLoading code editor

PutItemCommand Input

See PutItemCommandInput for more details

Parameter	Type	Description
`Item` Required	`Record<string, AttributeValue> \| undefined`	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.
`TableName` Required	`string \| undefined`	The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
`ConditionExpression`	`string \| undefined`	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.
`ConditionalOperator`	`ConditionalOperator \| undefined`	This is a legacy parameter. Use `ConditionExpression` instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
`Expected`	`Record<string, ExpectedAttributeValue> \| undefined`	This is a legacy parameter. Use `ConditionExpression` instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
`ExpressionAttributeNames`	`Record<string, string> \| undefined`	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`	`Record<string, AttributeValue> \| undefined`	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.
`ReturnConsumedCapacity`	`ReturnConsumedCapacity \| undefined`	Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response: `INDEXES` - The response includes the aggregate `ConsumedCapacity` for the operation, together with `ConsumedCapacity` for each table and secondary index that was accessed. Note that some operations, such as `GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s). `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation. `NONE` - No `ConsumedCapacity` details are included in the response.
`ReturnItemCollectionMetrics`	`ReturnItemCollectionMetrics \| undefined`	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`	`ReturnValue \| undefined`	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`	`ReturnValuesOnConditionCheckFailure \| undefined`	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.

PutItemCommand Output

See PutItemCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`Attributes`	`Record<string, AttributeValue> \| undefined`	The attribute values as they appeared before the `PutItem` operation, but only if `ReturnValues` is specified as `ALL_OLD` in the request. Each element consists of an attribute name and an attribute value.
`ConsumedCapacity`	`ConsumedCapacity \| undefined`	The capacity units consumed by the `PutItem` operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.
`ItemCollectionMetrics`	`ItemCollectionMetrics \| undefined`	Information about item collections, if any, that were affected by the `PutItem` operation. `ItemCollectionMetrics` is only returned if the `ReturnItemCollectionMetrics` parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each `ItemCollectionMetrics` element consists of: `ItemCollectionKey` - The partition key value of the item collection. This is the same as the partition key value of the item itself. `SizeEstimateRangeGB` - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Throws

Name	Fault	Details
ConditionalCheckFailedException	client	A condition specified in the operation could not be evaluated.
InternalServerError	server	An error occurred on the server side.
InvalidEndpointException	client
ItemCollectionSizeLimitExceededException	client	An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
ProvisionedThroughputExceededException	client	Your request rate is too high. The Amazon Web Services 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.
ReplicatedWriteConflictException	client	The request was rejected because one or more items in the request are being modified by a request in another Region.
RequestLimitExceeded	client	Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
ResourceNotFoundException	client	The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
TransactionConflictException	client	Operation was rejected because there is an ongoing transaction for the item.
DynamoDBServiceException		Base exception class for all service exceptions from DynamoDB service.

Getting Started

References