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
{
"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.
- 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
-
When specified as true, iterates through the account and returns all catalog resources (including top-level resources and child resources)
Type: Boolean
Required: No
Response Syntax
{
"CatalogList": [
{
"CatalogId": "string",
"CatalogProperties": {
"CustomProperties": {
"string" : "string"
},
"DataLakeAccessProperties": {
"CatalogType": "string",
"DataLakeAccess": boolean,
"DataTransferRole": "string",
"KmsKey": "string",
"ManagedWorkgroupName": "string",
"ManagedWorkgroupStatus": "string",
"RedshiftDatabaseName": "string",
"StatusMessage": "string"
}
},
"CreateDatabaseDefaultPermissions": [
{
"Permissions": [ "string" ],
"Principal": {
"DataLakePrincipalIdentifier": "string"
}
}
],
"CreateTableDefaultPermissions": [
{
"Permissions": [ "string" ],
"Principal": {
"DataLakePrincipalIdentifier": "string"
}
}
],
"CreateTime": number,
"Description": "string",
"FederatedCatalog": {
"ConnectionName": "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
Catalog
objects. A list ofCatalog
objects 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 Errors.
- AccessDeniedException
-
Access to a resource was denied.
HTTP Status Code: 400
- EntityNotFoundException
-
A specified entity does not exist
HTTP Status Code: 400
- FederationSourceException
-
A federation source failed.
HTTP Status Code: 400
- FederationSourceRetryableException
-
A federation source failed, but the operation may be retried.
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: