Get Catalogs

glue_get_catalogs

R Documentation

Retrieves all catalogs defined in a catalog in the Glue Data Catalog

Description

Retrieves all catalogs defined in a catalog in the Glue Data Catalog. For a Redshift-federated catalog use case, this operation returns the list of catalogs mapped to Redshift databases in the Redshift namespace catalog.

Usage

glue_get_catalogs(ParentCatalogId, NextToken, MaxResults, Recursive,
  IncludeRoot)

Arguments

ParentCatalogId

The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.

NextToken

A continuation token, if this is a continuation call.

MaxResults

The maximum number of catalogs to return in one response.

Recursive

Whether to list all catalogs across the catalog hierarchy, starting from the ParentCatalogId. Defaults to false . When true, all catalog objects in the ParentCatalogID hierarchy are enumerated in the response.

IncludeRoot

Whether to list the default catalog in the account and region in the response. Defaults to false. When true and ⁠ParentCatalogId = NULL | Amazon Web Services Account ID⁠, all catalogs and the default catalog are enumerated in the response.

When the ParentCatalogId is not equal to null, and this attribute is passed as false or true, an InvalidInputException is thrown.

Value

A list with the following syntax:

list(
  CatalogList = list(
    list(
      CatalogId = "string",
      Name = "string",
      ResourceArn = "string",
      Description = "string",
      Parameters = list(
        "string"
      ),
      CreateTime = as.POSIXct(
        "2015-01-01"
      ),
      UpdateTime = as.POSIXct(
        "2015-01-01"
      ),
      TargetRedshiftCatalog = list(
        CatalogArn = "string"
      ),
      FederatedCatalog = list(
        Identifier = "string",
        ConnectionName = "string"
      ),
      CatalogProperties = list(
        DataLakeAccessProperties = list(
          DataLakeAccess = TRUE|FALSE,
          DataTransferRole = "string",
          KmsKey = "string",
          ManagedWorkgroupName = "string",
          ManagedWorkgroupStatus = "string",
          RedshiftDatabaseName = "string",
          StatusMessage = "string",
          CatalogType = "string"
        ),
        CustomProperties = list(
          "string"
        )
      ),
      CreateTableDefaultPermissions = list(
        list(
          Principal = list(
            DataLakePrincipalIdentifier = "string"
          ),
          Permissions = list(
            "ALL"|"SELECT"|"ALTER"|"DROP"|"DELETE"|"INSERT"|"CREATE_DATABASE"|"CREATE_TABLE"|"DATA_LOCATION_ACCESS"
          )
        )
      ),
      CreateDatabaseDefaultPermissions = list(
        list(
          Principal = list(
            DataLakePrincipalIdentifier = "string"
          ),
          Permissions = list(
            "ALL"|"SELECT"|"ALTER"|"DROP"|"DELETE"|"INSERT"|"CREATE_DATABASE"|"CREATE_TABLE"|"DATA_LOCATION_ACCESS"
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_catalogs(
  ParentCatalogId = "string",
  NextToken = "string",
  MaxResults = 123,
  Recursive = TRUE|FALSE,
  IncludeRoot = TRUE|FALSE
)