Skip to content

Lists the data catalogs in the current Amazon Web Services account

Description

Lists the data catalogs in the current Amazon Web Services account.

In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.

Usage

athena_list_data_catalogs(NextToken, MaxResults, WorkGroup)

Arguments

  • NextToken

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

  • MaxResults

    Specifies the maximum number of data catalogs to return.

  • WorkGroup

    The name of the workgroup. Required if making an IAM Identity Center request.

Value

A list with the following syntax:

list(
  DataCatalogsSummary = list(
    list(
      CatalogName = "string",
      Type = "LAMBDA"|"GLUE"|"HIVE"|"FEDERATED",
      Status = "CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"CREATE_FAILED"|"CREATE_FAILED_CLEANUP_IN_PROGRESS"|"CREATE_FAILED_CLEANUP_COMPLETE"|"CREATE_FAILED_CLEANUP_FAILED"|"DELETE_IN_PROGRESS"|"DELETE_COMPLETE"|"DELETE_FAILED",
      ConnectionType = "DYNAMODB"|"MYSQL"|"POSTGRESQL"|"REDSHIFT"|"ORACLE"|"SYNAPSE"|"SQLSERVER"|"DB2"|"OPENSEARCH"|"BIGQUERY"|"GOOGLECLOUDSTORAGE"|"HBASE"|"DOCUMENTDB"|"CMDB"|"TPCDS"|"TIMESTREAM"|"SAPHANA"|"SNOWFLAKE"|"DATALAKEGEN2"|"DB2AS400",
      Error = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_data_catalogs(
  NextToken = "string",
  MaxResults = 123,
  WorkGroup = "string"
)