DescribeEntityCommand

Suggest an Edit

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 Syntax

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

import { GlueClient, DescribeEntityCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, DescribeEntityCommand } = require("@aws-sdk/client-glue"); // CommonJS import
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",
//       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
//         "<keys>": "STRING_VALUE",
//       },
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeEntityCommand Input

See DescribeEntityCommandInput for more details

Parameter
Type
Description
ConnectionName
Required
string | undefined

The name of the connection that contains the connection type credentials.

EntityName
Required
string | undefined

The name of the entity that you want to describe from the connection type.

CatalogId
string | undefined

The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.

DataStoreApiVersion
string | undefined

The version of the API used for the data store.

NextToken
string | undefined

A continuation token, included if this is a continuation call.

DescribeEntityCommand Output

See DescribeEntityCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Fields
Field[] | undefined

Describes the fields for that connector entity. This is the list of Field objects. Field is very similar to column in a database. The Field object has information about different properties associated with fields in the connector.

NextToken
string | undefined

A continuation token, present if the current segment is not the last.

Throws

Name
Fault
Details
AccessDeniedException
client

Access to a resource was denied.

EntityNotFoundException
client

A specified entity does not exist

FederationSourceException
client

A federation source failed.

GlueEncryptionException
client

An encryption operation failed.

InvalidInputException
client

The input provided was not valid.

OperationTimeoutException
client

The operation timed out.

ValidationException
client

A value could not be validated.

GlueServiceException
Base exception class for all service exceptions from Glue service.