odb / Client / get_autonomous_database_backup

get_autonomous_database_backup

odb.Client.get_autonomous_database_backup(**kwargs)

Gets information about a specific Autonomous Database backup.

See also: AWS API Documentation

Request Syntax

response = client.get_autonomous_database_backup(
    autonomousDatabaseBackupId='string'
)

Parameters:

autonomousDatabaseBackupId (string) –

[REQUIRED]

The unique identifier of the Autonomous Database backup to retrieve information about.

Return type:

dict

Returns:

Response Syntax

{
    'autonomousDatabaseBackup': {
        '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'
    }
}

Response Structure

• (dict) –

  • autonomousDatabaseBackup (dict) –

    The details of the requested 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.

Exceptions

• odb.Client.exceptions.ThrottlingException

• odb.Client.exceptions.ValidationException

• odb.Client.exceptions.AccessDeniedException

• odb.Client.exceptions.InternalServerException

• odb.Client.exceptions.ResourceNotFoundException