This example creates a table named Thread. The table primary key consists of ForumName (partition key) and Subject (sort key). A local secondary index is also created; its key consists of ForumName (partition key) and LastPostDateTime (sort key).
Sample Request
POST / HTTP/1.1
Host: dynamodb.<region>.<domain>;
Accept-Encoding: identity
Content-Length: <PayloadSizeBytes>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
X-Amz-Date: <Date>
X-Amz-Target: DynamoDB_20120810.CreateTable { "AttributeDefinitions": [
{
"AttributeName": "ForumName", "AttributeType": "S"
}, {
"AttributeName": "Subject", "AttributeType": "S"
}, {
"AttributeName": "LastPostDateTime",
CreateTable
"AttributeType": "S"
} ],
"TableName": "Thread", "KeySchema": [
"LocalSecondaryIndexes": [ {
"ProvisionedThroughput": { "ReadCapacityUnits": 5,
"TableDescription": {
"TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread", "AttributeDefinitions": [
CreateTable
"CreationDateTime": 1.36372808007E9, "ItemCount": 0,
"IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread/index/
LastPostIndex",
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
CreateTable
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteBackup
DeleteBackup
Service: Amazon DynamoDB
Deletes an existing backup of a table.
You can call DeleteBackup at a maximum rate of 10 times per second.
Request Syntax
{
"BackupArn": "string"
}
Request Parameters
The request accepts the following data in JSON format.
NoteIn the following list, the required parameters are described first.
BackupArn (p. 44)
The ARN associated with the backup.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
Required: Yes
Response Syntax
{
"BackupDescription": { "BackupDetails": { "BackupArn": "string",
"BackupCreationDateTime": number, "BackupExpiryDateTime": number, "BackupName": "string",
"BackupSizeBytes": number, "BackupStatus": "string", "BackupType": "string"
},
"SourceTableDetails": { "BillingMode": "string", "ItemCount": number, "KeySchema": [ {
"AttributeName": "string", "KeyType": "string"
} ],
"ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number },
"TableArn": "string",
"TableCreationDateTime": number, "TableId": "string",
"TableName": "string",
DeleteBackup
"TableSizeBytes": number },
"SourceTableFeatureDetails": { "GlobalSecondaryIndexes": [
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
BackupDescription (p. 44)
Contains the description of the backup created for the table.
DeleteBackup
Type: BackupDescription (p. 353) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 519).
BackupInUseException
There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
HTTP Status Code: 400 BackupNotFoundException
Backup not found for the given BackupARN.
HTTP Status Code: 400 InternalServerError
An error occurred on the server side.
HTTP Status Code: 500 LimitExceededException
There is no limit to the number of daily on-demand backups that can be taken.
Up to 50 simultaneous table operations are allowed per account. These operations include
CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.
There is a soft account quota of 256 tables.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteItem
DeleteItem
Service: Amazon DynamoDB
Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.
In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.
Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.
Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.
Request Syntax
{ "ConditionalOperator": "string", "ConditionExpression": "string", "Expected": {
"ExpressionAttributeNames": { "string" : "string"
DeleteItem
},
"ExpressionAttributeValues": { "string" : {
"ReturnConsumedCapacity": "string", "ReturnItemCollectionMetrics": "string", "ReturnValues": "string",
"TableName": "string"
}
Request Parameters
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
Key (p. 47)
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
For the primary key, you must provide all of the attributes. 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 values for both the partition key and the sort key.
Type: String to AttributeValue (p. 338) object map Key Length Constraints: Maximum length of 65535.
Required: Yes
DeleteItem
TableName (p. 47)
The name of the table from which to delete the item.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: [a-zA-Z0-9_.-]+
Required: Yes
ConditionalOperator (p. 47)
This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Type: String
Valid Values: AND | OR Required: No
ConditionExpression (p. 47)
A condition that must be satisfied in order for a conditional DeleteItem 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 about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
Type: String Required: No Expected (p. 47)
This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
Type: String to ExpectedAttributeValue (p. 385) object map Key Length Constraints: Maximum length of 65535.
Required: No
ExpressionAttributeNames (p. 47)
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:
DeleteItem
• 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
NoteTokens 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.
Type: String to string map
Value Length Constraints: Maximum length of 65535.
Required: No
ExpressionAttributeValues (p. 47)
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.
Type: String to AttributeValue (p. 338) object map Required: No
ReturnConsumedCapacity (p. 47)
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.
DeleteItem
Type: String
Valid Values: INDEXES | TOTAL | NONE Required: No
ReturnItemCollectionMetrics (p. 47)
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.
Type: String
Valid Values: SIZE | NONE Required: No
ReturnValues (p. 47)
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, 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 - The content of the old item is returned.
NoteThe ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.
Type: String
Valid Values: NONE | ALL_OLD | UPDATED_OLD | ALL_NEW | UPDATED_NEW Required: No
Response Syntax
{
"Attributes": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [
"AttributeValue"
], "M": {
"string" : "AttributeValue"
},
"N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] }
},
"ConsumedCapacity": { "CapacityUnits": number, "GlobalSecondaryIndexes": { "string" : {
DeleteItem
"ReadCapacityUnits": number, "Table": { "WriteCapacityUnits": number },
"ItemCollectionMetrics": { "ItemCollectionKey": {
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Attributes (p. 51)
A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.
Type: String to AttributeValue (p. 338) object map Key Length Constraints: Maximum length of 65535.
ConsumedCapacity (p. 51)
The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the
DeleteItem
operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Mode in the Amazon DynamoDB Developer Guide.
Type: ConsumedCapacity (p. 369) object ItemCollectionMetrics (p. 51)
Information about item collections, if any, that were affected by the DeleteItem 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.
Type: ItemCollectionMetrics (p. 409) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 519).
ConditionalCheckFailedException
A condition specified in the operation could not be evaluated.
HTTP Status Code: 400 InternalServerError
An error occurred on the server side.
HTTP Status Code: 500
ItemCollectionSizeLimitExceededException
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
HTTP Status Code: 400
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.
HTTP Status Code: 400 RequestLimitExceeded
Throughput exceeds the current throughput quota for your account. Please contact AWS Support to request a quota increase.
DeleteItem
HTTP Status Code: 400 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.
HTTP Status Code: 400 TransactionConflictException
Operation was rejected because there is an ongoing transaction for the item.
HTTP Status Code: 400