TimestreamInfluxDB / Paginator / ListDbBackups

ListDbBackups

class TimestreamInfluxDB.Paginator.ListDbBackups

paginator = client.get_paginator('list_db_backups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from TimestreamInfluxDB.Client.list_db_backups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    dbResourceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• dbResourceId (string) – The identifier of the DB instance or DB cluster to list backups for. If not specified, returns all backups in the account and region.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'DELETING'|'DELETED',
            'createdAt': datetime(2015, 1, 1),
            'expiresAfter': 'string',
            'dbResourceId': 'string',
            'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'ON_DEMAND'|'CONTINUOUS',
            'engineType': 'INFLUXDB_V2'|'INFLUXDB_V3_CORE'|'INFLUXDB_V3_ENTERPRISE',
            'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'|'MULTI_NODE_READ_REPLICAS',
            'kmsKeyId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    A list of Timestream for InfluxDB backup summaries.

    • (dict) –

      Contains a summary of a Timestream for InfluxDB backup.

      • id (string) –

        Service-generated unique identifier of the backup.

      • name (string) –

        The customer-provided name of the backup.

      • arn (string) –

        The Amazon Resource Name (ARN) of the backup.

      • status (string) –

        The status of the backup. Valid values are IN_PROGRESS, COMPLETED, FAILED, DELETING, and DELETED.

      • createdAt (datetime) –

        The time when the backup was created.

      • expiresAfter (string) –

        The date after which the backup will be automatically deleted.

      • dbResourceId (string) –

        The identifier of the DB resource that the backup was created from.

      • type (string) –

        The type of backup. Valid values are HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, ON_DEMAND, and CONTINUOUS.

      • engineType (string) –

        The engine type of the resource that the backup was created from.

      • deploymentType (string) –

        The deployment type of the resource that the backup was created from.

      • kmsKeyId (string) –

        The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup.

  • NextToken (string) –

    A token to resume pagination.