Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetDatabases

Retrieves all databases defined in a given Data Catalog.

Request Syntax


{
   "AttributesToGet": [ "string" ],
   "CatalogId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ResourceShareType": "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.

AttributesToGet

Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the NAME.

Type: Array of strings

Valid Values: NAME

Required: No

CatalogId

The ID of the Data Catalog from which to retrieve Databases. 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

MaxResults

The maximum number of databases to return in one response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

A continuation token, if this is a continuation call.

Type: String

Required: No

ResourceShareType

Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.

If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.
If set to FOREIGN, will list the databases shared with your account.
If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.

Type: String

Valid Values: FOREIGN | ALL | FEDERATED

Required: No

Response Syntax


{
   "DatabaseList": [ 
      { 
         "CatalogId": "string",
         "CreateTableDefaultPermissions": [ 
            { 
               "Permissions": [ "string" ],
               "Principal": { 
                  "DataLakePrincipalIdentifier": "string"
               }
            }
         ],
         "CreateTime": number,
         "Description": "string",
         "FederatedDatabase": { 
            "ConnectionName": "string",
            "ConnectionType": "string",
            "Identifier": "string"
         },
         "LocationUri": "string",
         "Name": "string",
         "Parameters": { 
            "string" : "string" 
         },
         "TargetDatabase": { 
            "CatalogId": "string",
            "DatabaseName": "string",
            "Region": "string"
         }
      }
   ],
   "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.

DatabaseList

A list of Database objects from the specified catalog.

Type: Array of Database 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.

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