UpdateCatalog
Updates an existing catalog's properties in the AWS Glue Data Catalog.
Request Syntax
{
"CatalogId": "string
",
"CatalogInput": {
"CatalogProperties": {
"CustomProperties": {
"string
" : "string
"
},
"DataLakeAccessProperties": {
"CatalogType": "string
",
"DataLakeAccess": boolean
,
"DataTransferRole": "string
",
"KmsKey": "string
"
}
},
"CreateDatabaseDefaultPermissions": [
{
"Permissions": [ "string
" ],
"Principal": {
"DataLakePrincipalIdentifier": "string
"
}
}
],
"CreateTableDefaultPermissions": [
{
"Permissions": [ "string
" ],
"Principal": {
"DataLakePrincipalIdentifier": "string
"
}
}
],
"Description": "string
",
"FederatedCatalog": {
"ConnectionName": "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.
HTTP Status Code: 400
- ConcurrentModificationException
-
Two processes are trying to modify a resource simultaneously.
HTTP Status Code: 400
- EntityNotFoundException
-
A specified entity does not exist
HTTP Status Code: 400
- FederationSourceException
-
A federation source failed.
HTTP Status Code: 400
- GlueEncryptionException
-
An encryption operation failed.
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: