Table of Contents

Class DeleteItemRequest

Namespace
Amazon.DynamoDBv2.Model
Assembly
AWSSDK.DynamoDBv2.dll

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. 

public class DeleteItemRequest : AmazonDynamoDBRequest
Inheritance
DeleteItemRequest

Constructors

DeleteItemRequest()

Empty constructor used to set properties independently even when a simple constructor is available

public DeleteItemRequest()

DeleteItemRequest(string, Dictionary<string, AttributeValue>)

Instantiates DeleteItemRequest with the parameterized properties

public DeleteItemRequest(string tableName, Dictionary<string, AttributeValue> key)

Parameters

tableName string

The name of the table from which to delete the item.

key Dictionary<string, AttributeValue>

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.

DeleteItemRequest(string, Dictionary<string, AttributeValue>, ReturnValue)

Instantiates DeleteItemRequest with the parameterized properties

public DeleteItemRequest(string tableName, Dictionary<string, AttributeValue> key, ReturnValue returnValues)

Parameters

tableName string

The name of the table from which to delete the item.

key Dictionary<string, AttributeValue>

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.
returnValues ReturnValue

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.
note

The 

ReturnValues
parameter is used by several DynamoDB operations; however, 
DeleteItem
does not recognize any values other than 
NONE
or 
ALL_OLD
.

Properties

ConditionExpression

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. 

public string ConditionExpression { get; set; }

Property Value

string

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. 
public ConditionalOperator ConditionalOperator { get; set; }

Property Value

ConditionalOperator

Expected

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. 
public Dictionary<string, ExpectedAttributeValue> Expected { get; set; }

Property Value

Dictionary<string, ExpectedAttributeValue>

ExpressionAttributeNames

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
note

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. 

public Dictionary<string, string> ExpressionAttributeNames { get; set; }

Property Value

Dictionary<string, string>

ExpressionAttributeValues

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. 

public Dictionary<string, AttributeValue> ExpressionAttributeValues { get; set; }

Property Value

Dictionary<string, AttributeValue>

Key

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 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. 

public Dictionary<string, AttributeValue> Key { get; set; }

Property Value

Dictionary<string, AttributeValue>

ReturnConsumedCapacity

Gets and sets the property ReturnConsumedCapacity.

public ReturnConsumedCapacity ReturnConsumedCapacity { get; set; }

Property Value

ReturnConsumedCapacity

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. 
public ReturnItemCollectionMetrics ReturnItemCollectionMetrics { get; set; }

Property Value

ReturnItemCollectionMetrics

ReturnValues

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.

note

The 

ReturnValues
parameter is used by several DynamoDB operations; however, 
DeleteItem
does not recognize any values other than 
NONE
or 
ALL_OLD
. 
public ReturnValue ReturnValues { get; set; }

Property Value

ReturnValue

TableName

Gets and sets the property TableName.

The name of the table from which to delete the item. 

public string TableName { get; set; }

Property Value

string