GetDatabase
Retrieves the definition of a specified database.
Request Syntax
{
"CatalogId": "string",
"Name": "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 Data Catalog in which the database resides. If none is provided, the AWS account ID 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
- Name
-
The name of the database to retrieve. For Hive compatibility, this should be all lowercase.
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
{
"Database": {
"CatalogId": "string",
"CreateTableDefaultPermissions": [
{
"Permissions": [ "string" ],
"Principal": {
"DataLakePrincipalIdentifier": "string"
}
}
],
"CreateTime": number,
"Description": "string",
"FederatedDatabase": {
"ConnectionName": "string",
"Identifier": "string"
},
"LocationUri": "string",
"Name": "string",
"Parameters": {
"string" : "string"
},
"TargetDatabase": {
"CatalogId": "string",
"DatabaseName": "string",
"Region": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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:
