Request Syntax Request Parameters Response Elements Errors See Also

UpdateCatalog

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

Request Syntax


{
   "CatalogId": "string",
   "CatalogInput": { 
      "AllowFullTableExternalDataAccess": "string",
      "CatalogProperties": { 
         "CustomProperties": { 
            "string" : "string" 
         },
         "DataLakeAccessProperties": { 
            "CatalogType": "string",
            "DataLakeAccess": boolean,
            "DataTransferRole": "string",
            "KmsKey": "string"
         },
         "IcebergOptimizationProperties": { 
            "Compaction": { 
               "string" : "string" 
            },
            "OrphanFileDeletion": { 
               "string" : "string" 
            },
            "Retention": { 
               "string" : "string" 
            },
            "RoleArn": "string"
         }
      },
      "CreateDatabaseDefaultPermissions": [ 
         { 
            "Permissions": [ "string" ],
            "Principal": { 
               "DataLakePrincipalIdentifier": "string"
            }
         }
      ],
      "CreateTableDefaultPermissions": [ 
         { 
            "Permissions": [ "string" ],
            "Principal": { 
               "DataLakePrincipalIdentifier": "string"
            }
         }
      ],
      "Description": "string",
      "FederatedCatalog": { 
         "ConnectionName": "string",
         "ConnectionType": "string",
         "Identifier": "string"
      },
      "Parameters": { 
         "string" : "string" 
      },
      "TargetRedshiftCatalog": { 
         "CatalogArn": "string"
      }
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CatalogId

The ID of the catalog.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

CatalogInput

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

Type: CatalogInput object

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to a resource was denied.

Message: A message describing the problem.

HTTP Status Code: 400

ConcurrentModificationException

Two processes are trying to modify a resource simultaneously.

Message: A message describing the problem.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

FederationSourceException

A federation source failed.

FederationSourceErrorCode: The error code of the problem.
Message: The message describing the problem.

HTTP Status Code: 400

GlueEncryptionException

An encryption operation failed.

Message: The message describing the problem.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

Message: A message describing the problem.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

Message: A message describing the problem.

HTTP Status Code: 400