DeleteItemRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the DeleteItem operation. 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.

In this article ▶

Inheritance Hierarchy

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

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

Syntax

public class DeleteItemRequest : AmazonDynamoDBRequest
         IAmazonWebServiceRequest

The DeleteItemRequest type exposes the following members

Constructors

	Name	Description
	DeleteItemRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	DeleteItemRequest(string, Dictionary<String, AttributeValue>)	Instantiates DeleteItemRequest with the parameterized properties
	DeleteItemRequest(string, Dictionary<String, AttributeValue>, ReturnValue)	Instantiates DeleteItemRequest 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 `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.
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Key	System.Collections.Generic.Dictionary<System.String, Amazon.DynamoDBv2.Model.AttributeValue>	Gets and sets the property Key. 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 key 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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
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 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. 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, `DeleteItem` 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 `DeleteItem` 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 from which to delete the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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<string, AttributeValue> key = new Dictionary<string, AttributeValue>
{
    { "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
await client.DeleteItemAsync(request);

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer