Skip to content

Returns the available entities supported by the connection type

Description

Returns the available entities supported by the connection type.

Usage

glue_list_entities(ConnectionName, CatalogId, ParentEntityName,
  NextToken, DataStoreApiVersion)

Arguments

  • ConnectionName

    A name for the connection that has required credentials to query any connection type.

  • 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.

  • ParentEntityName

    Name of the parent entity for which you want to list the children. This parameter takes a fully-qualified path of the entity in order to list the child entities.

  • NextToken

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

  • DataStoreApiVersion

    The API version of the SaaS connector.

Value

A list with the following syntax:

list(
  Entities = list(
    list(
      EntityName = "string",
      Label = "string",
      IsParentEntity = TRUE|FALSE,
      Description = "string",
      Category = "string",
      CustomProperties = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_entities(
  ConnectionName = "string",
  CatalogId = "string",
  ParentEntityName = "string",
  NextToken = "string",
  DataStoreApiVersion = "string"
)