Skip to content

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

Description

This API is used to query preview data from a given connection type or from a native Amazon S3 based 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 describe_entity API.

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

Usage

glue_get_entity_records(ConnectionName, CatalogId, EntityName,
  NextToken, DataStoreApiVersion, ConnectionOptions, FilterPredicate,
  Limit, OrderBy, SelectedFields)

Arguments

  • ConnectionName

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

  • CatalogId

    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.

  • EntityName

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

  • NextToken

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

  • DataStoreApiVersion

    The API version of the SaaS connector.

  • ConnectionOptions

    Connector options that are required to query the data.

  • FilterPredicate

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

  • Limit

    [required] Limits the number of records fetched with the request.

  • OrderBy

    A parameter that orders the response preview data.

  • SelectedFields

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

Value

A list with the following syntax:

list(
  Records = list(
    list()
  ),
  NextToken = "string"
)

Request syntax

svc$get_entity_records(
  ConnectionName = "string",
  CatalogId = "string",
  EntityName = "string",
  NextToken = "string",
  DataStoreApiVersion = "string",
  ConnectionOptions = list(
    "string"
  ),
  FilterPredicate = "string",
  Limit = 123,
  OrderBy = "string",
  SelectedFields = list(
    "string"
  )
)