Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DescribeTableCommand

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

example

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

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

DescribeTableCommandInput for command's input shape.

see

DescribeTableCommandOutput for command's response shape.

see

config for command's input shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

input: DescribeTableCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<DescribeTableCommandInput, DescribeTableCommandOutput>