Skip to content

delete_db_cluster

delete_db_cluster(
    db_cluster_id: DbClusterId,
    *,
    config_overrides: Optional[TimestreamInfluxDBClientConfig] = None,
    retain_automated_backups: Optional[bool] = None,
) -> DeleteDbClusterOutput

Deletes a Timestream for InfluxDB cluster.

Parameters:

  • db_cluster_id (DbClusterId) –

    Service-generated unique identifier of the DB cluster.

  • retain_automated_backups (Optional[bool], default: None ) –

    Specifies whether to retain automated backups after the DB cluster is deleted. If set to true, automated backups are not deleted and can be restored later.

Raises:

Source code in docs_src/capo_timestream_influxdb/_services/timestream_influx_db.py
def delete_db_cluster(
    self,
    db_cluster_id: "capo_timestream_influxdb.types.db_cluster_id.DbClusterId",
    *,
    config_overrides: Optional[TimestreamInfluxDBClientConfig] = None,
    retain_automated_backups: Optional[bool] = None,
) -> (
    "capo_timestream_influxdb.types.delete_db_cluster_output.DeleteDbClusterOutput"
):
    """<p>Deletes a Timestream for InfluxDB cluster.</p>

    Args:
        db_cluster_id: <p>Service-generated unique identifier of the DB cluster.</p>
        retain_automated_backups: <p>Specifies whether to retain automated backups after the DB cluster is deleted. If set to true, automated backups are not deleted and can be restored later.</p>

    Raises:
        capo_timestream_influxdb.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_timestream_influxdb.errors.conflict_exception.ConflictException: <p>The request conflicts with an existing resource in Timestream for InfluxDB.</p>
        capo_timestream_influxdb.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_timestream_influxdb.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found or does not exist.</p>
        capo_timestream_influxdb.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_timestream_influxdb.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
        capo_timestream_influxdb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_timestream_influxdb.types.delete_db_cluster_input.DeleteDbClusterInput]",
    ) -> OperationResponse[
        "capo_timestream_influxdb.types.delete_db_cluster_output.DeleteDbClusterOutput"
    ]:
        import capo_timestream_influxdb._operations.amazon_timestream_influx_db.delete_db_cluster

        output, http_response = (
            capo_timestream_influxdb._operations.amazon_timestream_influx_db.delete_db_cluster.delete_db_cluster(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDbCluster")
    )
    input_: capo_timestream_influxdb.types.delete_db_cluster_input.DeleteDbClusterInput = {
        "db_cluster_id": db_cluster_id
    }
    if retain_automated_backups is not None:
        input_["retain_automated_backups"] = retain_automated_backups

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output