Skip to content

delete_database async

delete_database(
    database_name: ResourceName,
    *,
    config_overrides: Optional[AsyncTimestreamWriteClientConfig] = None,
) -> None

Deletes a given Timestream database. This is an irreversible operation. After a database is deleted, the time-series data from its tables cannot be recovered.

All tables in the database must be deleted first, or a ValidationException error will be thrown.

Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.

See code sample for details.

Parameters:

  • database_name (ResourceName) –

    The name of the Timestream database to be deleted.

Raises:

Source code in docs_src/capo_timestream_write/_services/async_timestream_write.py
async def delete_database(
    self,
    database_name: "capo_timestream_write.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[AsyncTimestreamWriteClientConfig] = None,
) -> None:
    """<p>Deletes a given Timestream database. <i>This is an irreversible operation. After a database is deleted, the time-series data from its tables cannot be recovered.</i> </p> <note> <p>All tables in the database must be deleted first, or a ValidationException error will be thrown. </p> <p>Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.</p> </note> <p>See <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html">code sample</a> for details.</p>

    Args:
        database_name: <p>The name of the Timestream database to be deleted.</p>

    Raises:
        capo_timestream_write.errors.access_denied_exception.AccessDeniedException: <p>You are not authorized to perform this action.</p>
        capo_timestream_write.errors.internal_server_exception.InternalServerException: <p> Timestream was unable to fully process this request because of an internal server error.</p>
        capo_timestream_write.errors.invalid_endpoint_exception.InvalidEndpointException: <p>The requested endpoint was not valid.</p>
        capo_timestream_write.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.</p>
        capo_timestream_write.errors.throttling_exception.ThrottlingException: <p> Too many requests were made by a user and they exceeded the service quotas. The request was throttled.</p>
        capo_timestream_write.errors.validation_exception.ValidationException: <p> An invalid or malformed request.</p>
        capo_timestream_write.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_timestream_write.types.delete_database_request.DeleteDatabaseRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_timestream_write._operations.timestream_20181101.delete_database

        (
            output,
            http_response,
        ) = await capo_timestream_write._operations.timestream_20181101.delete_database.async_delete_database(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDatabase")
    )
    input_: capo_timestream_write.types.delete_database_request.DeleteDatabaseRequest = {
        "database_name": database_name
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output