Skip to content

Returns table metadata for the specified catalog, database, and table

Description

Returns table metadata for the specified catalog, database, and table.

Usage

athena_get_table_metadata(CatalogName, DatabaseName, TableName,
  WorkGroup)

Arguments

  • CatalogName

    [required] The name of the data catalog that contains the database and table metadata to return.

  • DatabaseName

    [required] The name of the database that contains the table metadata to return.

  • TableName

    [required] The name of the table for which metadata is returned.

  • WorkGroup

    The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

Value

A list with the following syntax:

list(
  TableMetadata = list(
    Name = "string",
    CreateTime = as.POSIXct(
      "2015-01-01"
    ),
    LastAccessTime = as.POSIXct(
      "2015-01-01"
    ),
    TableType = "string",
    Columns = list(
      list(
        Name = "string",
        Type = "string",
        Comment = "string"
      )
    ),
    PartitionKeys = list(
      list(
        Name = "string",
        Type = "string",
        Comment = "string"
      )
    ),
    Parameters = list(
      "string"
    )
  )
)

Request syntax

svc$get_table_metadata(
  CatalogName = "string",
  DatabaseName = "string",
  TableName = "string",
  WorkGroup = "string"
)