GetCatalogCommand

Suggest an Edit

The name of the Catalog to retrieve. This should be all lowercase.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GlueClient, GetCatalogCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, GetCatalogCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // GetCatalogRequest
  CatalogId: "STRING_VALUE", // required
};
const command = new GetCatalogCommand(input);
const response = await client.send(command);
// { // GetCatalogResponse
//   Catalog: { // Catalog
//     CatalogId: "STRING_VALUE",
//     Name: "STRING_VALUE", // required
//     ResourceArn: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     Parameters: { // ParametersMap
//       "<keys>": "STRING_VALUE",
//     },
//     CreateTime: new Date("TIMESTAMP"),
//     UpdateTime: new Date("TIMESTAMP"),
//     TargetRedshiftCatalog: { // TargetRedshiftCatalog
//       CatalogArn: "STRING_VALUE", // required
//     },
//     FederatedCatalog: { // FederatedCatalog
//       Identifier: "STRING_VALUE",
//       ConnectionName: "STRING_VALUE",
//     },
//     CatalogProperties: { // CatalogPropertiesOutput
//       DataLakeAccessProperties: { // DataLakeAccessPropertiesOutput
//         DataLakeAccess: true || false,
//         DataTransferRole: "STRING_VALUE",
//         KmsKey: "STRING_VALUE",
//         ManagedWorkgroupName: "STRING_VALUE",
//         ManagedWorkgroupStatus: "STRING_VALUE",
//         RedshiftDatabaseName: "STRING_VALUE",
//         StatusMessage: "STRING_VALUE",
//         CatalogType: "STRING_VALUE",
//       },
//       CustomProperties: {
//         "<keys>": "STRING_VALUE",
//       },
//     },
//     CreateTableDefaultPermissions: [ // PrincipalPermissionsList
//       { // PrincipalPermissions
//         Principal: { // DataLakePrincipal
//           DataLakePrincipalIdentifier: "STRING_VALUE",
//         },
//         Permissions: [ // PermissionList
//           "ALL" || "SELECT" || "ALTER" || "DROP" || "DELETE" || "INSERT" || "CREATE_DATABASE" || "CREATE_TABLE" || "DATA_LOCATION_ACCESS",
//         ],
//       },
//     ],
//     CreateDatabaseDefaultPermissions: [
//       {
//         Principal: {
//           DataLakePrincipalIdentifier: "STRING_VALUE",
//         },
//         Permissions: [
//           "ALL" || "SELECT" || "ALTER" || "DROP" || "DELETE" || "INSERT" || "CREATE_DATABASE" || "CREATE_TABLE" || "DATA_LOCATION_ACCESS",
//         ],
//       },
//     ],
//     AllowFullTableExternalDataAccess: "True" || "False",
//   },
// };

GetCatalogCommand Input

See GetCatalogCommandInput for more details

Parameter
Type
Description
CatalogId
Required
string | undefined

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.

GetCatalogCommand Output

See GetCatalogCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Catalog
Catalog | undefined

A Catalog object. The definition of the specified catalog in the Glue Data Catalog.

Throws

Name
Fault
Details
AccessDeniedException
client

Access to a resource was denied.

EntityNotFoundException
client

A specified entity does not exist

FederationSourceException
client

A federation source failed.

FederationSourceRetryableException
client

A federation source failed, but the operation may be retried.

GlueEncryptionException
client

An encryption operation failed.

InternalServiceException
server

An internal service error occurred.

InvalidInputException
client

The input provided was not valid.

OperationTimeoutException
client

The operation timed out.

GlueServiceException
Base exception class for all service exceptions from Glue service.