Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteItemAsync C# (CSharp) Method

AmazonDynamoDBClient Class Documentation Show file Open project: aws/aws-sdk-net

DeleteItemAsync() public method

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.

/// A condition specified in the operation could not be evaluated. /// /// An error occurred on the server side. /// /// An item collection is too large. This exception is only returned for tables that have /// one or more local secondary indexes. /// /// 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. /// /// The operation tried to access a nonexistent table or index. The resource might not /// be specified correctly, or its status might not be ACTIVE. ///

public DeleteItemAsync ( string tableName, AttributeValue>.Dictionary key, ReturnValue returnValues, System cancellationToken = default(CancellationToken) ) : Task
tableName	string	The name of the table from which to delete the item.
key	AttributeValue>.Dictionary	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. The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than `NONE` or `ALL_OLD`.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

        public Task<DeleteItemResponse> DeleteItemAsync(string tableName, Dictionary<string, AttributeValue> key, ReturnValue returnValues, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
        {
            var request = new DeleteItemRequest();
            request.TableName = tableName;
            request.Key = key;
            request.ReturnValues = returnValues;
            return DeleteItemAsync(request, cancellationToken);
        }

Same methods

AmazonDynamoDBClient::DeleteItemAsync ( DeleteItemRequest request, System cancellationToken = default(CancellationToken) ) : Task
AmazonDynamoDBClient::DeleteItemAsync ( string tableName, AttributeValue>.Dictionary key, System cancellationToken = default(CancellationToken) ) : Task