Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DeleteDataCatalog

Deletes a data catalog.

Request Syntax


{
   "DeleteCatalogOnly": boolean,
   "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.

DeleteCatalogOnly

Deletes the Athena Data Catalog. You can only use this with the FEDERATED catalogs. You usually perform this before registering the connector with Glue Data Catalog. After deletion, you will have to manage the Glue Connection and Lambda function.

Type: Boolean

Required: No

Name

The name of the data catalog to delete.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Response Syntax


{
   "DataCatalog": { 
      "ConnectionType": "string",
      "Description": "string",
      "Error": "string",
      "Name": "string",
      "Parameters": { 
         "string" : "string" 
      },
      "Status": "string",
      "Type": "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.

DataCatalog

Contains information about a data catalog in an 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.

Type: DataCatalog object

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