Skip to content

delete_db_instance 

delete_db_instance(
    identifier: DbInstanceIdentifier,
    *,
    config_overrides: Optional[TimestreamInfluxDBClientConfig] = None,
    retain_automated_backups: Optional[bool] = None,
) -> DeleteDbInstanceOutput

Deletes a Timestream for InfluxDB DB instance.

Parameters:

  • identifier (DbInstanceIdentifier) –

    The id of the DB instance.

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

    Specifies whether to retain automated backups after the DB instance 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 
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
def delete_db_instance(
    self,
    identifier: "capo_timestream_influxdb.types.db_instance_identifier.DbInstanceIdentifier",
    *,
    config_overrides: Optional[TimestreamInfluxDBClientConfig] = None,
    retain_automated_backups: Optional[bool] = None,
) -> "capo_timestream_influxdb.types.delete_db_instance_output.DeleteDbInstanceOutput":
    """<p>Deletes a Timestream for InfluxDB DB instance.</p>

    Args:
        identifier: <p>The id of the DB instance.</p>
        retain_automated_backups: <p>Specifies whether to retain automated backups after the DB instance 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_instance_input.DeleteDbInstanceInput]",
    ) -> OperationResponse[
        "capo_timestream_influxdb.types.delete_db_instance_output.DeleteDbInstanceOutput"
    ]:
        import capo_timestream_influxdb._operations.amazon_timestream_influx_db.delete_db_instance

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDbInstance")
    )
    input_: capo_timestream_influxdb.types.delete_db_instance_input.DeleteDbInstanceInput = {
        "identifier": identifier
    }
    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