Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListDataCatalogs

Lists the data catalogs in the current AWS account.

Note

In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "WorkGroup": "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.

MaxResults

Specifies the maximum number of data catalogs to return.

Type: Integer

Valid Range: Minimum value of 2. Maximum value of 50.

Required: No

NextToken

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

The name of the workgroup. Required if making an IAM Identity Center request.

Type: String

Pattern: [a-zA-Z0-9._-]{1,128}

Required: No

Response Syntax


{
   "DataCatalogsSummary": [ 
      { 
         "CatalogName": "string",
         "ConnectionType": "string",
         "Error": "string",
         "Status": "string",
         "Type": "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.

DataCatalogsSummary

A summary list of data catalogs.

Type: Array of DataCatalogSummary objects

NextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

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.

HTTP Status Code: 400