Skip to content

list_db_backups async

list_db_backups(
    *,
    config_overrides: Optional[AsyncTimestreamInfluxDBClientConfig] = None,
    db_resource_id: Optional[DbResourceId] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListDbBackupsOutput

Returns a list of Timestream for InfluxDB backups.

Parameters:

  • db_resource_id (Optional[DbResourceId], default: None ) –

    The identifier of the DB instance or DB cluster to list backups for. If not specified, returns all backups in the account and region.

  • next_token (Optional[NextToken], default: None ) –

    The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.

Raises:

Source code in docs_src/capo_timestream_influxdb/_services/async_timestream_influx_db.py
async def list_db_backups(
    self,
    *,
    config_overrides: Optional[AsyncTimestreamInfluxDBClientConfig] = None,
    db_resource_id: Optional[
        "capo_timestream_influxdb.types.db_resource_id.DbResourceId"
    ] = None,
    next_token: Optional[
        "capo_timestream_influxdb.types.next_token.NextToken"
    ] = None,
    max_results: Optional[
        "capo_timestream_influxdb.types.max_results.MaxResults"
    ] = None,
) -> "capo_timestream_influxdb.types.list_db_backups_output.ListDbBackupsOutput":
    """<p>Returns a list of Timestream for InfluxDB backups.</p>

    Args:
        db_resource_id: <p>The identifier of the DB instance or DB cluster to list backups for. If not specified, returns all backups in the account and region.</p>
        next_token: <p>The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.</p>
        max_results: <p>The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_timestream_influxdb.types.list_db_backups_input.ListDbBackupsInput]",
    ) -> AsyncOperationResponse[
        "capo_timestream_influxdb.types.list_db_backups_output.ListDbBackupsOutput"
    ]:
        import capo_timestream_influxdb._operations.amazon_timestream_influx_db.list_db_backups

        (
            output,
            http_response,
        ) = await capo_timestream_influxdb._operations.amazon_timestream_influx_db.list_db_backups.async_list_db_backups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDbBackups")
    )
    input_: capo_timestream_influxdb.types.list_db_backups_input.ListDbBackupsInput = {}
    if db_resource_id is not None:
        input_["db_resource_id"] = db_resource_id
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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