Skip to content

Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity

Description

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.

Usage

glue_describe_entity(ConnectionName, CatalogId, EntityName, NextToken,
  DataStoreApiVersion)

Arguments

  • ConnectionName

    [required] 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] The name of the entity that you want to describe from the connection type.

  • NextToken

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

  • DataStoreApiVersion

    The version of the API used for the data store.

Value

A list with the following syntax:

list(
  Fields = list(
    list(
      FieldName = "string",
      Label = "string",
      Description = "string",
      FieldType = "INT"|"SMALLINT"|"BIGINT"|"FLOAT"|"LONG"|"DATE"|"BOOLEAN"|"MAP"|"ARRAY"|"STRING"|"TIMESTAMP"|"DECIMAL"|"BYTE"|"SHORT"|"DOUBLE"|"STRUCT"|"BINARY"|"UNION",
      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 = list(
        "string"
      ),
      SupportedFilterOperators = list(
        "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",
      NativeDataType = "string",
      CustomProperties = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_entity(
  ConnectionName = "string",
  CatalogId = "string",
  EntityName = "string",
  NextToken = "string",
  DataStoreApiVersion = "string"
)