选择您的 Cookie 首选项

我们使用必要 Cookie 和类似工具提供我们的网站和服务。我们使用性能 Cookie 收集匿名统计数据,以便我们可以了解客户如何使用我们的网站并进行改进。必要 Cookie 无法停用,但您可以单击“自定义”或“拒绝”来拒绝性能 Cookie。

如果您同意,AWS 和经批准的第三方还将使用 Cookie 提供有用的网站功能、记住您的首选项并显示相关内容,包括相关广告。要接受或拒绝所有非必要 Cookie,请单击“接受”或“拒绝”。要做出更详细的选择,请单击“自定义”。

GetEntityRecords - AWS Glue
此页面尚未翻译为您的语言。 请求翻译

GetEntityRecords

This API is used to query preview data from a given connection type or from a native Amazon S3 based AWS Glue Data Catalog.

Returns records as an array of JSON blobs. Each record is formatted using Jackson JsonNode based on the field type defined by the DescribeEntity API.

Spark connectors generate schemas according to the same data type mapping as in the DescribeEntity API. Spark connectors convert data to the appropriate data types matching the schema when returning rows.

Request Syntax

{ "CatalogId": "string", "ConnectionName": "string", "ConnectionOptions": { "string" : "string" }, "DataStoreApiVersion": "string", "EntityName": "string", "FilterPredicate": "string", "Limit": number, "NextToken": "string", "OrderBy": "string", "SelectedFields": [ "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: No

ConnectionOptions

Connector options that are required to query the data.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 100 items.

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

Key Pattern: [\w]*

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

Value Pattern: [\S]*

Required: No

DataStoreApiVersion

The API version of the SaaS connector.

Type: String

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

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

Required: No

EntityName

Name of the entity that we want to query the preview data from the given connection type.

Type: String

Required: Yes

FilterPredicate

A filter predicate that you can apply in the query request.

Type: String

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

Required: No

Limit

Limits the number of records fetched with the request.

Type: Long

Valid Range: Minimum value of 1. Maximum value of 1000.

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

OrderBy

A parameter that orders the response preview data.

Type: String

Required: No

SelectedFields

List of fields that we want to fetch as part of preview data.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 1000 items.

Required: No

Response Syntax

{ "NextToken": "string", "Records": [ JSON value ] }

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.

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+=/:_]*

Records

A list of the requested objects.

Type: Array of JSON values

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. 或其附属公司。保留所有权利。