TimestreamInfluxDB / Client / list_db_backups

list_db_backups

TimestreamInfluxDB.Client.list_db_backups(**kwargs)

Returns a list of Timestream for InfluxDB backups.

See also: AWS API Documentation

Request Syntax

response = client.list_db_backups(
    dbResourceId='string',
    nextToken='string',
    maxResults=123
)
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.

  • nextToken (string) – The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.

  • maxResults (integer) – 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.

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) –

      Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.

Exceptions