- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteDbClusterCommand
Deletes a Timestream for InfluxDB cluster.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { TimestreamInfluxDBClient, DeleteDbClusterCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import
// const { TimestreamInfluxDBClient, DeleteDbClusterCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import
const client = new TimestreamInfluxDBClient(config);
const input = { // DeleteDbClusterInput
dbClusterId: "STRING_VALUE", // required
};
const command = new DeleteDbClusterCommand(input);
const response = await client.send(command);
// { // DeleteDbClusterOutput
// dbClusterStatus: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED",
// };
DeleteDbClusterCommand Input
See DeleteDbClusterCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
dbClusterIdRequired | string | undefined | Service-generated unique identifier of the DB cluster. |
DeleteDbClusterCommand Output
See DeleteDbClusterCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
dbClusterStatus | ClusterStatus | undefined | The status of the DB cluster. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You do not have sufficient access to perform this action. |
| ConflictException | client | The request conflicts with an existing resource in Timestream for InfluxDB. |
| InternalServerException | server | The request processing has failed because of an unknown error, exception or failure. |
| ResourceNotFoundException | client | The requested resource was not found or does not exist. |
| ThrottlingException | client | The request was denied due to request throttling. |
| ValidationException | client | The input fails to satisfy the constraints specified by Timestream for InfluxDB. |
| TimestreamInfluxDBServiceException | Base exception class for all service exceptions from TimestreamInfluxDB service. |