Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

DeleteTableCommand

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. For the full list of table states, see TableStatus .

When you delete a table, any indexes on that table are also deleted.

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.

Use the DescribeTable action to check the status of the table.

Example Syntax

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

import { DynamoDBClient, DeleteTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, DeleteTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // DeleteTableInput
  TableName: "STRING_VALUE", // required
};
const command = new DeleteTableCommand(input);
const response = await client.send(command);
// { // DeleteTableOutput
//   TableDescription: { // TableDescription
//     AttributeDefinitions: [ // AttributeDefinitions
//       { // AttributeDefinition
//         AttributeName: "STRING_VALUE", // required
//         AttributeType: "S" || "N" || "B", // required
//       },
//     ],
//     TableName: "STRING_VALUE",
//     KeySchema: [ // KeySchema
//       { // KeySchemaElement
//         AttributeName: "STRING_VALUE", // required
//         KeyType: "HASH" || "RANGE", // required
//       },
//     ],
//     TableStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED",
//     CreationDateTime: new Date("TIMESTAMP"),
//     ProvisionedThroughput: { // ProvisionedThroughputDescription
//       LastIncreaseDateTime: new Date("TIMESTAMP"),
//       LastDecreaseDateTime: new Date("TIMESTAMP"),
//       NumberOfDecreasesToday: Number("long"),
//       ReadCapacityUnits: Number("long"),
//       WriteCapacityUnits: Number("long"),
//     },
//     TableSizeBytes: Number("long"),
//     ItemCount: Number("long"),
//     TableArn: "STRING_VALUE",
//     TableId: "STRING_VALUE",
//     BillingModeSummary: { // BillingModeSummary
//       BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
//       LastUpdateToPayPerRequestDateTime: new Date("TIMESTAMP"),
//     },
//     LocalSecondaryIndexes: [ // LocalSecondaryIndexDescriptionList
//       { // LocalSecondaryIndexDescription
//         IndexName: "STRING_VALUE",
//         KeySchema: [
//           {
//             AttributeName: "STRING_VALUE", // required
//             KeyType: "HASH" || "RANGE", // required
//           },
//         ],
//         Projection: { // Projection
//           ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
//           NonKeyAttributes: [ // NonKeyAttributeNameList
//             "STRING_VALUE",
//           ],
//         },
//         IndexSizeBytes: Number("long"),
//         ItemCount: Number("long"),
//         IndexArn: "STRING_VALUE",
//       },
//     ],
//     GlobalSecondaryIndexes: [ // GlobalSecondaryIndexDescriptionList
//       { // GlobalSecondaryIndexDescription
//         IndexName: "STRING_VALUE",
//         KeySchema: [
//           {
//             AttributeName: "STRING_VALUE", // required
//             KeyType: "HASH" || "RANGE", // required
//           },
//         ],
//         Projection: {
//           ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
//           NonKeyAttributes: [
//             "STRING_VALUE",
//           ],
//         },
//         IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
//         Backfilling: true || false,
//         ProvisionedThroughput: {
//           LastIncreaseDateTime: new Date("TIMESTAMP"),
//           LastDecreaseDateTime: new Date("TIMESTAMP"),
//           NumberOfDecreasesToday: Number("long"),
//           ReadCapacityUnits: Number("long"),
//           WriteCapacityUnits: Number("long"),
//         },
//         IndexSizeBytes: Number("long"),
//         ItemCount: Number("long"),
//         IndexArn: "STRING_VALUE",
//         OnDemandThroughput: { // OnDemandThroughput
//           MaxReadRequestUnits: Number("long"),
//           MaxWriteRequestUnits: Number("long"),
//         },
//         WarmThroughput: { // GlobalSecondaryIndexWarmThroughputDescription
//           ReadUnitsPerSecond: Number("long"),
//           WriteUnitsPerSecond: Number("long"),
//           Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
//         },
//       },
//     ],
//     StreamSpecification: { // StreamSpecification
//       StreamEnabled: true || false, // required
//       StreamViewType: "NEW_IMAGE" || "OLD_IMAGE" || "NEW_AND_OLD_IMAGES" || "KEYS_ONLY",
//     },
//     LatestStreamLabel: "STRING_VALUE",
//     LatestStreamArn: "STRING_VALUE",
//     GlobalTableVersion: "STRING_VALUE",
//     Replicas: [ // ReplicaDescriptionList
//       { // ReplicaDescription
//         RegionName: "STRING_VALUE",
//         ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS",
//         ReplicaStatusDescription: "STRING_VALUE",
//         ReplicaStatusPercentProgress: "STRING_VALUE",
//         KMSMasterKeyId: "STRING_VALUE",
//         ProvisionedThroughputOverride: { // ProvisionedThroughputOverride
//           ReadCapacityUnits: Number("long"),
//         },
//         OnDemandThroughputOverride: { // OnDemandThroughputOverride
//           MaxReadRequestUnits: Number("long"),
//         },
//         WarmThroughput: { // TableWarmThroughputDescription
//           ReadUnitsPerSecond: Number("long"),
//           WriteUnitsPerSecond: Number("long"),
//           Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED",
//         },
//         GlobalSecondaryIndexes: [ // ReplicaGlobalSecondaryIndexDescriptionList
//           { // ReplicaGlobalSecondaryIndexDescription
//             IndexName: "STRING_VALUE",
//             ProvisionedThroughputOverride: {
//               ReadCapacityUnits: Number("long"),
//             },
//             OnDemandThroughputOverride: {
//               MaxReadRequestUnits: Number("long"),
//             },
//             WarmThroughput: {
//               ReadUnitsPerSecond: Number("long"),
//               WriteUnitsPerSecond: Number("long"),
//               Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
//             },
//           },
//         ],
//         ReplicaInaccessibleDateTime: new Date("TIMESTAMP"),
//         ReplicaTableClassSummary: { // TableClassSummary
//           TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
//           LastUpdateDateTime: new Date("TIMESTAMP"),
//         },
//       },
//     ],
//     RestoreSummary: { // RestoreSummary
//       SourceBackupArn: "STRING_VALUE",
//       SourceTableArn: "STRING_VALUE",
//       RestoreDateTime: new Date("TIMESTAMP"), // required
//       RestoreInProgress: true || false, // required
//     },
//     SSEDescription: { // SSEDescription
//       Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED" || "UPDATING",
//       SSEType: "AES256" || "KMS",
//       KMSMasterKeyArn: "STRING_VALUE",
//       InaccessibleEncryptionDateTime: new Date("TIMESTAMP"),
//     },
//     ArchivalSummary: { // ArchivalSummary
//       ArchivalDateTime: new Date("TIMESTAMP"),
//       ArchivalReason: "STRING_VALUE",
//       ArchivalBackupArn: "STRING_VALUE",
//     },
//     TableClassSummary: {
//       TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
//       LastUpdateDateTime: new Date("TIMESTAMP"),
//     },
//     DeletionProtectionEnabled: true || false,
//     OnDemandThroughput: {
//       MaxReadRequestUnits: Number("long"),
//       MaxWriteRequestUnits: Number("long"),
//     },
//     WarmThroughput: {
//       ReadUnitsPerSecond: Number("long"),
//       WriteUnitsPerSecond: Number("long"),
//       Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED",
//     },
//     MultiRegionConsistency: "EVENTUAL" || "STRONG",
//   },
// };

Example Usage

Loading code editor