import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeTableRequest, DescribeTableResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @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(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns information about the table, including the table name, database name, retention * duration of the memory store and the magnetic store. Service quotas apply. See * code * sample for details.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { TimestreamWriteClient, DescribeTableCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import * // const { TimestreamWriteClient, DescribeTableCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import * // import type { TimestreamWriteClientConfig } from "@aws-sdk/client-timestream-write"; * const config = {}; // type is TimestreamWriteClientConfig * const client = new TimestreamWriteClient(config); * const input = { // DescribeTableRequest * DatabaseName: "STRING_VALUE", // required * TableName: "STRING_VALUE", // required * }; * const command = new DescribeTableCommand(input); * const response = await client.send(command); * // { // DescribeTableResponse * // Table: { // Table * // Arn: "STRING_VALUE", * // TableName: "STRING_VALUE", * // DatabaseName: "STRING_VALUE", * // TableStatus: "ACTIVE" || "DELETING" || "RESTORING", * // RetentionProperties: { // RetentionProperties * // MemoryStoreRetentionPeriodInHours: Number("long"), // required * // MagneticStoreRetentionPeriodInDays: Number("long"), // required * // }, * // CreationTime: new Date("TIMESTAMP"), * // LastUpdatedTime: new Date("TIMESTAMP"), * // MagneticStoreWriteProperties: { // MagneticStoreWriteProperties * // EnableMagneticStoreWrites: true || false, // required * // MagneticStoreRejectedDataLocation: { // MagneticStoreRejectedDataLocation * // S3Configuration: { // S3Configuration * // BucketName: "STRING_VALUE", * // ObjectKeyPrefix: "STRING_VALUE", * // EncryptionOption: "SSE_S3" || "SSE_KMS", * // KmsKeyId: "STRING_VALUE", * // }, * // }, * // }, * // Schema: { // Schema * // CompositePartitionKey: [ // PartitionKeyList * // { // PartitionKey * // Type: "DIMENSION" || "MEASURE", // required * // Name: "STRING_VALUE", * // EnforcementInRecord: "REQUIRED" || "OPTIONAL", * // }, * // ], * // }, * // }, * // }; * * ``` * * @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 TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You are not authorized to perform this action.

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

* Timestream was unable to fully process this request because of an internal server * error.

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

The requested endpoint was not valid.

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

The operation tried to access a nonexistent resource. The resource might not be * specified correctly, or its status might not be ACTIVE.

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

Too many requests were made by a user and they exceeded the service quotas. The request * was throttled.

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

An invalid or malformed request.

* * @throws {@link TimestreamWriteServiceException} *

Base exception class for all service exceptions from TimestreamWrite 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; }; }; }