DescribeTable - Documentation

The DescribeTable operation returns information about the table.

Source:

describe-table.js, line 2

See:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html

Methods

(inner) describeTable(request) → {Promise}

Source:

describe-table.js, line 35

See:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html#API_DescribeTable_RequestParameters

Retrieves information about the table.

Example

// 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.
 await describeTable({
   TableName: 'SomeTable'
 });

Parameters:

Name	Type	Description
`request`	Object	Parameters as expected by DynamoDB `DescribeTable` operation. Must contain, at least, `TableName` attribute.

Returns:

A promise that resolves to the response from DynamoDB.

Type: Promise

(inner) describeTableFor(tableName, requestopt) → {Promise}

Source:

describe-table.js, line 59

See:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html#API_DescribeTable_RequestParameters

Creates a function that describe given table. You would typically use this function through forTable.

Examples

// 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.
 await describeTableFor('SomeTable')

// Exported from `forTable`
 const { describeTable } = forTable('SomeTable');
 await describeTable();

Parameters:

Name	Type	Attributes	Description
`tableName`	String		The name of the table to perform the operation on
`request`	Object	<optional>	Parameters as expected by DynamoDB `DescribeTable` operation. A `TableName` attributes specified here will override `tableName` argument.

Returns:

A promise that resolves to the response from DynamoDB.

Type: Promise