Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Amazon.DynamoDBv2.Model.DeleteItemRequest Class Reference

Container for the parameters to the DeleteItem operation. More...

Inheritance diagram for Amazon.DynamoDBv2.Model.DeleteItemRequest:
Amazon.DynamoDBv2.AmazonDynamoDBv2Request

Properties

string TableName [get, set]
 The name of the table from which to delete the item. More...
 
Dictionary< string,
AttributeValue
Key [get, set]
 A map of attribute names to AttributeValue objects, representing the primary key of the item to delete. More...
 
Dictionary< string,
ExpectedAttributeValue
Expected [get, set]
 A map of attribute/condition pairs. This is the conditional block for the DeleteItemoperation. All the conditions must be met for the operation to succeed. Expected allows you to provide an attribute name, and whether or not Amazon 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 Amazon DynamoDB to check, along with the following: More...
 
ReturnValue ReturnValues [get, set]
 Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are: More...
 
ReturnConsumedCapacity ReturnConsumedCapacity [get, set]
 If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included. More...
 
ReturnItemCollectionMetrics ReturnItemCollectionMetrics [get, set]
 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.. More...
 

Detailed Description

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, Amazon DynamoDB performs the delete. Otherwise, the item is not deleted.

Property Documentation

Dictionary<string,ExpectedAttributeValue> Amazon.DynamoDBv2.Model.DeleteItemRequest.Expected
getset

A map of attribute/condition pairs. This is the conditional block for the DeleteItemoperation. All the conditions must be met for the operation to succeed. Expected allows you to provide an attribute name, and whether or not Amazon 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 Amazon DynamoDB to check, along with the following:

  • Value - The attribute value for Amazon DynamoDB to check.
  • Exists - Causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:
    • If Exists is true, Amazon 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, Amazon 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, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied. Amazon 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 for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.

Dictionary<string,AttributeValue> Amazon.DynamoDBv2.Model.DeleteItemRequest.Key
getset

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

ReturnConsumedCapacity Amazon.DynamoDBv2.Model.DeleteItemRequest.ReturnConsumedCapacity
getset

If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included.

Constraints:

  • Allowed Values INDEXES, TOTAL, NONE
ReturnItemCollectionMetrics Amazon.DynamoDBv2.Model.DeleteItemRequest.ReturnItemCollectionMetrics
getset

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
ReturnValue Amazon.DynamoDBv2.Model.DeleteItemRequest.ReturnValues
getset

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
string Amazon.DynamoDBv2.Model.DeleteItemRequest.TableName
getset

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

Constraints:

  • Length 3 - 255
  • Pattern [a-zA-Z0-9_.-]+

The documentation for this class was generated from the following file: