쿠키 기본 설정 선택

당사는 사이트와 서비스를 제공하는 데 필요한 필수 쿠키 및 유사한 도구를 사용합니다. 고객이 사이트를 어떻게 사용하는지 파악하고 개선할 수 있도록 성능 쿠키를 사용해 익명의 통계를 수집합니다. 필수 쿠키는 비활성화할 수 없지만 '사용자 지정' 또는 ‘거부’를 클릭하여 성능 쿠키를 거부할 수 있습니다.

사용자가 동의하는 경우 AWS와 승인된 제3자도 쿠키를 사용하여 유용한 사이트 기능을 제공하고, 사용자의 기본 설정을 기억하고, 관련 광고를 비롯한 관련 콘텐츠를 표시합니다. 필수가 아닌 모든 쿠키를 수락하거나 거부하려면 ‘수락’ 또는 ‘거부’를 클릭하세요. 더 자세한 내용을 선택하려면 ‘사용자 정의’를 클릭하세요.

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:

프라이버시사이트 이용 약관쿠키 기본 설정
© 2025, Amazon Web Services, Inc. 또는 계열사. All rights reserved.