# ListDatabases
<a name="API_ListDatabases"></a>

Lists the databases in the specified data catalog.

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

```
{
   "CatalogName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "WorkGroup": "string"
}
```

## Request Parameters
<a name="API_ListDatabases_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.

 ** [CatalogName](#API_ListDatabases_RequestSyntax) **   <a name="athena-ListDatabases-request-CatalogName"></a>
The name of the data catalog that contains the databases to return.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*`   
Required: Yes

 ** [MaxResults](#API_ListDatabases_RequestSyntax) **   <a name="athena-ListDatabases-request-MaxResults"></a>
Specifies the maximum number of results to return.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListDatabases_RequestSyntax) **   <a name="athena-ListDatabases-request-NextToken"></a>
A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the `NextToken` from the response object of the previous page call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** [WorkGroup](#API_ListDatabases_RequestSyntax) **   <a name="athena-ListDatabases-request-WorkGroup"></a>
The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Amazon Glue Data Catalog.  
Type: String  
Pattern: `[a-zA-Z0-9._-]{1,128}`   
Required: No

## Response Syntax
<a name="API_ListDatabases_ResponseSyntax"></a>

```
{
   "DatabaseList": [ 
      { 
         "Description": "string",
         "Name": "string",
         "Parameters": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDatabases_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.

 ** [DatabaseList](#API_ListDatabases_ResponseSyntax) **   <a name="athena-ListDatabases-response-DatabaseList"></a>
A list of databases from a data catalog.  
Type: Array of [Database](API_Database.md) objects

 ** [NextToken](#API_ListDatabases_ResponseSyntax) **   <a name="athena-ListDatabases-response-NextToken"></a>
A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

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

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

 ** InternalServerException **   
Indicates a platform issue, which may be due to a transient condition or outage.  
HTTP Status Code: 500

 ** InvalidRequestException **   
Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.    
 ** AthenaErrorCode **   
The error code returned when the query execution failed to process, or when the processing request for the named query failed.
HTTP Status Code: 400

 ** MetadataException **   
An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (`InvalidRequestException`) or from the Athena platform (`InternalServerException`). For example, if a user-created Lambda function is missing permissions, the Lambda `4XX` exception is returned in a `MetadataException`.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/athena-2017-05-18/ListDatabases) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/athena-2017-05-18/ListDatabases) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/athena-2017-05-18/ListDatabases) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/athena-2017-05-18/ListDatabases) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/athena-2017-05-18/ListDatabases) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/athena-2017-05-18/ListDatabases) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/athena-2017-05-18/ListDatabases) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/athena-2017-05-18/ListDatabases) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/athena-2017-05-18/ListDatabases) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/athena-2017-05-18/ListDatabases)