# GetCatalog
<a name="API_GetCatalog"></a>

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

## Request Syntax
<a name="API_GetCatalog_RequestSyntax"></a>

```
{
   "CatalogId": "{{string}}"
}
```

## Request Parameters
<a name="API_GetCatalog_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [CatalogId](#API_GetCatalog_RequestSyntax) **   <a name="Glue-GetCatalog-request-CatalogId"></a>
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
<a name="API_GetCatalog_ResponseSyntax"></a>

```
{
   "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
<a name="API_GetCatalog_ResponseElements"></a>

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](#API_GetCatalog_ResponseSyntax) **   <a name="Glue-GetCatalog-response-Catalog"></a>
A `Catalog` object. The definition of the specified catalog in the AWS Glue Data Catalog.  
Type: [Catalog](API_Catalog.md) object

## Errors
<a name="API_GetCatalog_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetCatalog_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/glue-2017-03-31/GetCatalog) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/glue-2017-03-31/GetCatalog) 
+  [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/glue-2017-03-31/GetCatalog) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/glue-2017-03-31/GetCatalog) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/glue-2017-03-31/GetCatalog) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/glue-2017-03-31/GetCatalog) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/glue-2017-03-31/GetCatalog) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/glue-2017-03-31/GetCatalog) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/glue-2017-03-31/GetCatalog) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/glue-2017-03-31/GetCatalog)