DeleteItemRequest Class

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 only deleting items if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

Declaration Syntax

public class DeleteItemRequest : AmazonWebServiceRequest

Members

Icon	Member	Description
	DeleteItemRequest()()()()	Initializes a new instance of the DeleteItemRequest class
	ConditionalOperator	A logical operator to apply to the conditions in the Expected map: AND - If all of the conditions evaluate to true, then the entire map evaluates to true. OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true. If you omit ConditionalOperator, then AND is used as the default. The operation will succeed only if the entire map evaluates to true. Constraints: Allowed Values AND, OR
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Expected	A map of attribute/condition pairs. This is the conditional block for the DeleteItem operation. Expected allows you to provide an attribute name, and whether or not DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it. Each item in Expected represents an attribute name for DynamoDB to check, along with the following: Value - A value for DynamoDB to compare with an attribute. When performing the comparison, strongly consistent reads are used. Exists - Causes DynamoDB to evaluate the value before attempting a conditional operation: If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException. If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException. The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied. DynamoDB returns a ValidationException if: Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.) Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.) If you specify more than one condition in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) If Expected evaluates to true, then the conditional operation succeeds; otherwise, it fails.
	GetHashCode()()()()	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType()()()()	Gets the type of the current instance. (Inherited from Object.)
	Key	A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
	ReturnConsumedCapacity	If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response. Constraints: Allowed Values INDEXES, TOTAL, NONE
	ReturnItemCollectionMetrics	If set to SIZE, 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. Constraints: Allowed Values SIZE, NONE
	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 is the default for ReturnValues.) ALL_OLD - The content of the old item is returned. Constraints: Allowed Values NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
	TableName	The name of the table from which to delete the item. Constraints: Length 3 - 255 Pattern [a-zA-Z0-9_.-]+
	ToString()()()()	Returns a string that represents the current object. (Inherited from Object.)
	WithConditionalOperator(String)	Obsolete. Sets the ConditionalOperator property
	WithExpected(array<KeyValuePair<(Of <<'(String, ExpectedAttributeValue>)>>)>[]()[][])	Obsolete. Adds the KeyValuePairs to the Expected dictionary.
	WithKey(array<KeyValuePair<(Of <<'(String, AttributeValue>)>>)>[]()[][])	Obsolete. Adds the KeyValuePairs to the Key dictionary.
	WithReturnConsumedCapacity(String)	Obsolete. Sets the ReturnConsumedCapacity property
	WithReturnItemCollectionMetrics(String)	Obsolete. Sets the ReturnItemCollectionMetrics property
	WithReturnValues(String)	Obsolete. Sets the ReturnValues property
	WithTableName(String)	Obsolete. Sets the TableName property

Examples

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

CopyDeleteItem 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
client.DeleteItem(request);

Inheritance Hierarchy

Object
	AmazonWebServiceRequest
		DeleteItemRequest

All Members	Constructors	Methods	Properties
Public Protected		Instance Static		Declared Inherited