import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GlueClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GlueClient"; import type { DescribeEntityRequest, DescribeEntityResponse } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeEntityCommand}. */ export interface DescribeEntityCommandInput extends DescribeEntityRequest { } /** * @public * * The output of {@link DescribeEntityCommand}. */ export interface DescribeEntityCommandOutput extends DescribeEntityResponse, __MetadataBearer { } declare const DescribeEntityCommand_base: { new (input: DescribeEntityCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeEntityCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity.

*

The response includes all the fields which make up the entity.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { GlueClient, DescribeEntityCommand } from "@aws-sdk/client-glue"; // ES Modules import * // const { GlueClient, DescribeEntityCommand } = require("@aws-sdk/client-glue"); // CommonJS import * // import type { GlueClientConfig } from "@aws-sdk/client-glue"; * const config = {}; // type is GlueClientConfig * const client = new GlueClient(config); * const input = { // DescribeEntityRequest * ConnectionName: "STRING_VALUE", // required * CatalogId: "STRING_VALUE", * EntityName: "STRING_VALUE", // required * NextToken: "STRING_VALUE", * DataStoreApiVersion: "STRING_VALUE", * }; * const command = new DescribeEntityCommand(input); * const response = await client.send(command); * // { // DescribeEntityResponse * // Fields: [ // FieldsList * // { // Field * // FieldName: "STRING_VALUE", * // Label: "STRING_VALUE", * // Description: "STRING_VALUE", * // FieldType: "INT" || "SMALLINT" || "BIGINT" || "FLOAT" || "LONG" || "DATE" || "BOOLEAN" || "MAP" || "ARRAY" || "STRING" || "TIMESTAMP" || "DECIMAL" || "BYTE" || "SHORT" || "DOUBLE" || "STRUCT" || "BINARY" || "UNION", * // IsPrimaryKey: true || false, * // IsNullable: true || false, * // IsRetrievable: true || false, * // IsFilterable: true || false, * // IsPartitionable: true || false, * // IsCreateable: true || false, * // IsUpdateable: true || false, * // IsUpsertable: true || false, * // IsDefaultOnCreate: true || false, * // SupportedValues: [ // ListOfString * // "STRING_VALUE", * // ], * // SupportedFilterOperators: [ // FieldFilterOperatorsList * // "LESS_THAN" || "GREATER_THAN" || "BETWEEN" || "EQUAL_TO" || "NOT_EQUAL_TO" || "GREATER_THAN_OR_EQUAL_TO" || "LESS_THAN_OR_EQUAL_TO" || "CONTAINS" || "ORDER_BY", * // ], * // ParentField: "STRING_VALUE", * // NativeDataType: "STRING_VALUE", * // CustomProperties: { // CustomProperties * // "": "STRING_VALUE", * // }, * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeEntityCommandInput - {@link DescribeEntityCommandInput} * @returns {@link DescribeEntityCommandOutput} * @see {@link DescribeEntityCommandInput} for command's `input` shape. * @see {@link DescribeEntityCommandOutput} for command's `response` shape. * @see {@link GlueClientResolvedConfig | config} for GlueClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Access to a resource was denied.

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

A specified entity does not exist

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

A federation source failed.

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

An encryption operation failed.

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

The input provided was not valid.

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

The operation timed out.

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

A value could not be validated.

* * @throws {@link GlueServiceException} *

Base exception class for all service exceptions from Glue service.

* * * @public */ export declare class DescribeEntityCommand extends DescribeEntityCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeEntityRequest; output: DescribeEntityResponse; }; sdk: { input: DescribeEntityCommandInput; output: DescribeEntityCommandOutput; }; }; }