Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeleteItemCommand

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.

example

Use a bare-bones client and the command you need to make an API call.

import { DynamoDBClient, DeleteItemCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, DeleteItemCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const command = new DeleteItemCommand(input);
const response = await client.send(command);
see

DeleteItemCommandInput for command's input shape.

see

DeleteItemCommandOutput for command's response shape.

see

config for DynamoDBClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: DeleteItemCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<DeleteItemCommandInput, DeleteItemCommandOutput>

Methods

Static getEndpointParameterInstructions