選取您的 Cookie 偏好設定

我們使用提供自身網站和服務所需的基本 Cookie 和類似工具。我們使用效能 Cookie 收集匿名統計資料,以便了解客戶如何使用我們的網站並進行改進。基本 Cookie 無法停用,但可以按一下「自訂」或「拒絕」以拒絕效能 Cookie。

如果您同意,AWS 與經核准的第三方也會使用 Cookie 提供實用的網站功能、記住您的偏好設定,並顯示相關內容,包括相關廣告。若要接受或拒絕所有非必要 Cookie,請按一下「接受」或「拒絕」。若要進行更詳細的選擇,請按一下「自訂」。

DescribeEntity - AWS Glue
此頁面尚未翻譯為您的語言。 請求翻譯

DescribeEntity

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.

Request Syntax

{ "CatalogId": "string", "ConnectionName": "string", "DataStoreApiVersion": "string", "EntityName": "string", "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CatalogId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

ConnectionName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

DataStoreApiVersion

The version of the API used for the data store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9.-]*

Required: No

EntityName

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

Type: String

Required: Yes

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [-a-zA-Z0-9+=/:_]*

Required: No

Response Syntax

{ "Fields": [ { "CustomProperties": { "string" : "string" }, "Description": "string", "FieldName": "string", "FieldType": "string", "IsCreateable": boolean, "IsDefaultOnCreate": boolean, "IsFilterable": boolean, "IsNullable": boolean, "IsPartitionable": boolean, "IsPrimaryKey": boolean, "IsRetrievable": boolean, "IsUpdateable": boolean, "IsUpsertable": boolean, "Label": "string", "NativeDataType": "string", "ParentField": "string", "SupportedFilterOperators": [ "string" ], "SupportedValues": [ "string" ] } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Fields

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.

Type: Array of Field objects

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [-a-zA-Z0-9+=/:_]*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to a resource was denied.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

FederationSourceException

A federation source failed.

HTTP Status Code: 400

GlueEncryptionException

An encryption operation failed.

HTTP Status Code: 400

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400

ValidationException

A value could not be validated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

隱私權網站條款Cookie 偏好設定
© 2025, Amazon Web Services, Inc.或其附屬公司。保留所有權利。