New API Documentation - Developer Preview Available
We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
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
Use a bare-bones client and the command you need to make an API call.
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.
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, theattribute_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
Use a bare-bones client and the command you need to make an API call.
Param
PutItemCommandInput
Returns
PutItemCommandOutput
See
input
shape.response
shape.config
shape.Throws
ConditionalCheckFailedException (client fault)
A condition specified in the operation could not be evaluated.
Throws
InternalServerError (server fault)
An error occurred on the server side.
Throws
InvalidEndpointException (client fault)
Throws
ItemCollectionSizeLimitExceededException (client fault)
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
Throws
ProvisionedThroughputExceededException (client fault)
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.
Throws
RequestLimitExceeded (client fault)
Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
Throws
ResourceNotFoundException (client fault)
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be
ACTIVE
.Throws
TransactionConflictException (client fault)
Operation was rejected because there is an ongoing transaction for the item.
Throws
DynamoDBServiceException
Base exception class for all service exceptions from DynamoDB service.
Example
To add an item to a table