AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For PCL and Unity this operation is only available in asynchronous form. Please refer to DeleteItemAsync.

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

Syntax

C#
public virtual DeleteItemResponse DeleteItem(
         DeleteItemRequest request
)
Parameters
request
Type: Amazon.DynamoDBv2.Model.DeleteItemRequest

Container for the necessary parameters to execute the DeleteItem service method.

Return Value
The response from the DeleteItem service method, as returned by DynamoDB.

Exceptions

ExceptionCondition
ConditionalCheckFailedException A condition specified in the operation could not be evaluated.
InternalServerErrorException An error occurred on the server side.
ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
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.
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.

Examples

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

DeleteItem sample


// Create a client
AmazonDynamoDBClient client = new AmazonDynamoDBClient();

// Define item key
//  Hash-key of the target item is string value "Mark Twain"
//  Range-key of the target item is string value "The Adventures of Tom Sawyer"
Dictionary key = new Dictionary
{
    { "Author", new AttributeValue { S = "Mark Twain" } },
    { "Title", new AttributeValue { S = "The Adventures of Tom Sawyer" } }
};

// Create DeleteItem request
DeleteItemRequest request = new DeleteItemRequest
{
    TableName = "SampleTable",
    Key = key
};

// Issue request
client.DeleteItem(request);

                

Version Information

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also