odb / Paginator / ListAutonomousDatabaseBackups

ListAutonomousDatabaseBackups

class odb.Paginator.ListAutonomousDatabaseBackups

paginator = client.get_paginator('list_autonomous_database_backups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from odb.Client.list_autonomous_database_backups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    autonomousDatabaseId='string',
    status='ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'FAILED',
    type='INCREMENTAL'|'FULL'|'LONGTERM'|'VIRTUAL_FULL'|'CUMULATIVE_INCREMENTAL'|'ROLL_FORWARD_IMAGE_COPY',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• autonomousDatabaseId (string) –

  [REQUIRED]

  The unique identifier of the Autonomous Database whose backups you want to list.

• status (string) – The status of the Autonomous Database backups to return results for.

• type (string) – The type of the Autonomous Database backups to return results for.

• 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

{
    'autonomousDatabaseBackups': [
        {
            'autonomousDatabaseBackupId': 'string',
            'autonomousDatabaseBackupArn': 'string',
            'autonomousDatabaseId': 'string',
            'ocid': 'string',
            'displayName': 'string',
            'dbVersion': 'string',
            'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'FAILED',
            'statusReason': 'string',
            'isAutomatic': True|False,
            'retentionPeriodInDays': 123,
            'sizeInTBs': 123.0,
            'timeAvailableTill': datetime(2015, 1, 1),
            'timeStarted': datetime(2015, 1, 1),
            'timeEnded': datetime(2015, 1, 1),
            'type': 'INCREMENTAL'|'FULL'|'LONGTERM'|'VIRTUAL_FULL'|'CUMULATIVE_INCREMENTAL'|'ROLL_FORWARD_IMAGE_COPY'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • autonomousDatabaseBackups (list) –

    The list of Autonomous Database backups along with their properties.

    • (dict) –

      A summary of an Autonomous Database backup.

      • autonomousDatabaseBackupId (string) –

        The unique identifier of the Autonomous Database backup.

      • autonomousDatabaseBackupArn (string) –

        The Amazon Resource Name (ARN) of the Autonomous Database backup.

      • autonomousDatabaseId (string) –

        The unique identifier of the Autonomous Database that the backup was created from.

      • ocid (string) –

        The Oracle Cloud Identifier (OCID) of the Autonomous Database backup.

      • displayName (string) –

        The user-friendly name of the Autonomous Database backup.

      • dbVersion (string) –

        The Oracle Database software version of the Autonomous Database backup.

      • status (string) –

        The current status of the Autonomous Database backup.

      • statusReason (string) –

        Additional information about the current status of the Autonomous Database backup, if applicable.

      • isAutomatic (boolean) –

        Indicates whether the backup was created automatically.

      • retentionPeriodInDays (integer) –

        The retention period, in days, for the Autonomous Database backup.

      • sizeInTBs (float) –

        The size of the Autonomous Database backup, in terabytes (TB).

      • timeAvailableTill (datetime) –

        The date and time until which the Autonomous Database backup is available for restore.

      • timeStarted (datetime) –

        The date and time when the Autonomous Database backup started.

      • timeEnded (datetime) –

        The date and time when the Autonomous Database backup ended.

      • type (string) –

        The type of the Autonomous Database backup.

  • NextToken (string) –

    A token to resume pagination.