DynamoDB / Client / describe_continuous_backups

describe_continuous_backups

DynamoDB.Client.describe_continuous_backups(**kwargs)

Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

After continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.

LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days.

You can call DescribeContinuousBackups at a maximum rate of 10 times per second.

See also: AWS API Documentation

Request Syntax

response = client.describe_continuous_backups(
    TableName='string'
)
Parameters:

TableName (string) –

[REQUIRED]

Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.

You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Return type:

dict

Returns:

Response Syntax

{
    'ContinuousBackupsDescription': {
        'ContinuousBackupsStatus': 'ENABLED'|'DISABLED',
        'PointInTimeRecoveryDescription': {
            'PointInTimeRecoveryStatus': 'ENABLED'|'DISABLED',
            'RecoveryPeriodInDays': 123,
            'EarliestRestorableDateTime': datetime(2015, 1, 1),
            'LatestRestorableDateTime': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) –

    • ContinuousBackupsDescription (dict) –

      Represents the continuous backups and point in time recovery settings on the table.

      • ContinuousBackupsStatus (string) –

        ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED

      • PointInTimeRecoveryDescription (dict) –

        The description of the point in time recovery settings applied to the table.

        • PointInTimeRecoveryStatus (string) –

          The current state of point in time recovery:

          • ENABLED - Point in time recovery is enabled.

          • DISABLED - Point in time recovery is disabled.

        • RecoveryPeriodInDays (integer) –

          The number of preceding days for which continuous backups are taken and maintained. Your table data is only recoverable to any point-in-time from within the configured recovery period. This parameter is optional.

        • EarliestRestorableDateTime (datetime) –

          Specifies the earliest point in time you can restore your table to. You can restore your table to any point in time during the last 35 days.

        • LatestRestorableDateTime (datetime) –

          LatestRestorableDateTime is typically 5 minutes before the current time.

Exceptions