UpdateCatalogCommand

Suggest an Edit

Updates an existing catalog's properties in the Glue Data Catalog.

Example Syntax

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

import { GlueClient, UpdateCatalogCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, UpdateCatalogCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // UpdateCatalogRequest
  CatalogId: "STRING_VALUE", // required
  CatalogInput: { // CatalogInput
    Description: "STRING_VALUE",
    FederatedCatalog: { // FederatedCatalog
      Identifier: "STRING_VALUE",
      ConnectionName: "STRING_VALUE",
    },
    Parameters: { // ParametersMap
      "<keys>": "STRING_VALUE",
    },
    TargetRedshiftCatalog: { // TargetRedshiftCatalog
      CatalogArn: "STRING_VALUE", // required
    },
    CatalogProperties: { // CatalogProperties
      DataLakeAccessProperties: { // DataLakeAccessProperties
        DataLakeAccess: true || false,
        DataTransferRole: "STRING_VALUE",
        KmsKey: "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",
  },
};
const command = new UpdateCatalogCommand(input);
const response = await client.send(command);
// {};

UpdateCatalogCommand Input

See UpdateCatalogCommandInput for more details

Parameter
Type
Description
CatalogId
Required
string | undefined

The ID of the catalog.

CatalogInput
Required
CatalogInput | undefined

A CatalogInput object specifying the new properties of an existing catalog.

UpdateCatalogCommand Output

See UpdateCatalogCommandOutput for details

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

Throws

Name
Fault
Details
AccessDeniedException
client

Access to a resource was denied.

ConcurrentModificationException
client

Two processes are trying to modify a resource simultaneously.

EntityNotFoundException
client

A specified entity does not exist

FederationSourceException
client

A federation source failed.

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.