Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetCatalog

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

Request Syntax


{
   "CatalogId": "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 parent catalog in which the catalog resides. If none is provided, the AWS Account Number is used by default.

Type: String

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

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

Required: Yes

Response Syntax


{
   "Catalog": { 
      "AllowFullTableExternalDataAccess": "string",
      "CatalogId": "string",
      "CatalogProperties": { 
         "CustomProperties": { 
            "string" : "string" 
         },
         "DataLakeAccessProperties": { 
            "CatalogType": "string",
            "DataLakeAccess": boolean,
            "DataTransferRole": "string",
            "KmsKey": "string",
            "ManagedWorkgroupName": "string",
            "ManagedWorkgroupStatus": "string",
            "RedshiftDatabaseName": "string",
            "StatusMessage": "string"
         },
         "IcebergOptimizationProperties": { 
            "Compaction": { 
               "string" : "string" 
            },
            "LastUpdatedTime": number,
            "OrphanFileDeletion": { 
               "string" : "string" 
            },
            "Retention": { 
               "string" : "string" 
            },
            "RoleArn": "string"
         }
      },
      "CreateDatabaseDefaultPermissions": [ 
         { 
            "Permissions": [ "string" ],
            "Principal": { 
               "DataLakePrincipalIdentifier": "string"
            }
         }
      ],
      "CreateTableDefaultPermissions": [ 
         { 
            "Permissions": [ "string" ],
            "Principal": { 
               "DataLakePrincipalIdentifier": "string"
            }
         }
      ],
      "CreateTime": number,
      "Description": "string",
      "FederatedCatalog": { 
         "ConnectionName": "string",
         "ConnectionType": "string",
         "Identifier": "string"
      },
      "Name": "string",
      "Parameters": { 
         "string" : "string" 
      },
      "ResourceArn": "string",
      "TargetRedshiftCatalog": { 
         "CatalogArn": "string"
      },
      "UpdateTime": number
   }
}

Response Elements

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

The following data is returned in JSON format by the service.

Catalog

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

Type: Catalog object

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

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

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

FederationSourceRetryableException

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

Message: A 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