import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeTableRequest, DescribeTableResponse } from "../models/models_0"; import type { RedshiftDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RedshiftDataClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeTableCommand}. */ export interface DescribeTableCommandInput extends DescribeTableRequest { } /** * @public * * The output of {@link DescribeTableCommand}. */ export interface DescribeTableCommandOutput extends DescribeTableResponse, __MetadataBearer { } declare const DescribeTableCommand_base: { new (input: DescribeTableCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeTableCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { RedshiftDataClient, DescribeTableCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import * // const { RedshiftDataClient, DescribeTableCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import * // import type { RedshiftDataClientConfig } from "@aws-sdk/client-redshift-data"; * const config = {}; // type is RedshiftDataClientConfig * const client = new RedshiftDataClient(config); * const input = { // DescribeTableRequest * ClusterIdentifier: "STRING_VALUE", * SecretArn: "STRING_VALUE", * DbUser: "STRING_VALUE", * Database: "STRING_VALUE", // required * ConnectedDatabase: "STRING_VALUE", * Schema: "STRING_VALUE", * Table: "STRING_VALUE", * NextToken: "STRING_VALUE", * MaxResults: Number("int"), * WorkgroupName: "STRING_VALUE", * }; * const command = new DescribeTableCommand(input); * const response = await client.send(command); * // { // DescribeTableResponse * // TableName: "STRING_VALUE", * // ColumnList: [ // ColumnList * // { // ColumnMetadata * // isCaseSensitive: true || false, * // isCurrency: true || false, * // isSigned: true || false, * // label: "STRING_VALUE", * // name: "STRING_VALUE", * // nullable: Number("int"), * // precision: Number("int"), * // scale: Number("int"), * // schemaName: "STRING_VALUE", * // tableName: "STRING_VALUE", * // typeName: "STRING_VALUE", * // length: Number("int"), * // columnDefault: "STRING_VALUE", * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeTableCommandInput - {@link DescribeTableCommandInput} * @returns {@link DescribeTableCommandOutput} * @see {@link DescribeTableCommandInput} for command's `input` shape. * @see {@link DescribeTableCommandOutput} for command's `response` shape. * @see {@link RedshiftDataClientResolvedConfig | config} for RedshiftDataClient's `config` shape. * * @throws {@link DatabaseConnectionException} (server fault) *

Connection to a database failed.

* * @throws {@link InternalServerException} (server fault) *

The Amazon Redshift Data API operation failed due to invalid input.

* * @throws {@link QueryTimeoutException} (client fault) *

The Amazon Redshift Data API operation failed due to timeout.

* * @throws {@link ResourceNotFoundException} (client fault) *

The Amazon Redshift Data API operation failed due to a missing resource.

* * @throws {@link ValidationException} (client fault) *

The Amazon Redshift Data API operation failed due to invalid input.

* * @throws {@link RedshiftDataServiceException} *

Base exception class for all service exceptions from RedshiftData service.

* * * @public */ export declare class DescribeTableCommand extends DescribeTableCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeTableRequest; output: DescribeTableResponse; }; sdk: { input: DescribeTableCommandInput; output: DescribeTableCommandOutput; }; }; }