Smaws_Client_DynamoDB.DeleteItem
val request :
Smaws_Lib.Context.t ->
delete_item_input ->
(delete_item_output,
[> Smaws_Lib.Protocols.AwsJson.error
| `ConditionalCheckFailedException of conditional_check_failed_exception
| `InternalServerError of internal_server_error
| `InvalidEndpointException of invalid_endpoint_exception
| `ItemCollectionSizeLimitExceededException of
item_collection_size_limit_exceeded_exception
| `ProvisionedThroughputExceededException of
provisioned_throughput_exceeded_exception
| `RequestLimitExceeded of request_limit_exceeded
| `ResourceNotFoundException of resource_not_found_exception
| `TransactionConflictException of transaction_conflict_exception ])
Stdlib.result
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.