GetCatalogs
Retrieves all catalogs defined in a catalog in the AWS Glue Data Catalog. For a Redshift-federated catalog use case, this operation returns the list of catalogs mapped to Redshift databases in the Redshift namespace catalog.
Request Syntax
{
"HasDatabases": boolean,
"IncludeRoot": boolean,
"MaxResults": number,
"NextToken": "string",
"ParentCatalogId": "string",
"Recursive": boolean
}
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.
- HasDatabases
-
When
true, the response only includes catalogs that can contain databases. Some catalogs are organizational containers that hold only other catalogs, not databases. When this parameter is set totrue, those container-only catalogs are excluded, and only catalogs capable of containing databases are returned. Defaults tofalse.Type: Boolean
Required: No
- IncludeRoot
-
Whether to list the default catalog in the account and region in the response. Defaults to
false. WhentrueandParentCatalogId = NULL | AWS Account ID, all catalogs and the default catalog are enumerated in the response.When the
ParentCatalogIdis not equal to null, and this attribute is passed asfalseortrue, anInvalidInputExceptionis thrown.Type: Boolean
Required: No
- MaxResults
-
The maximum number of catalogs to return in one response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- NextToken
-
A continuation token, if this is a continuation call.
Type: String
Required: No
- ParentCatalogId
-
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: No
- Recursive
-
Whether to list all catalogs across the catalog hierarchy, starting from the
ParentCatalogId. Defaults tofalse. Whentrue, all catalog objects in theParentCatalogIDhierarchy are enumerated in the response.Type: Boolean
Required: No
Response Syntax
{
"CatalogList": [
{
"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
}
],
"NextToken": "string"
}
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.
- CatalogList
-
An array of
Catalogobjects. A list ofCatalogobjects from the specified parent catalog.Type: Array of Catalog objects
- NextToken
-
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
Type: String
Errors
For information about the errors that are common to all actions, see Common Error Types.
- 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
- 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
For more information about using this API in one of the language-specific AWS SDKs, see the following: