Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . dynamodb ]

list-backups

Description

List backups associated with an AWS account. To list backups for a given table, specify table-name . list-backups returns a paginated list of results with at most 1MB worth of items in a page. You can also specify a limit for the maximum number of entries to be returned in a page.

In the request, start time is inclusive but end time is exclusive. Note that these limits are for the time at which the original backup was requested.

You can call list-backups a maximum of 5 times per second.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-backups
[--table-name <value>]
[--limit <value>]
[--time-range-lower-bound <value>]
[--time-range-upper-bound <value>]
[--exclusive-start-backup-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--table-name (string)

The backups from the table specified by table-name are listed.

--limit (integer)

Maximum number of backups to return at once.

--time-range-lower-bound (timestamp)

Only backups created after this time are listed. time-range-lower-bound is inclusive.

--time-range-upper-bound (timestamp)

Only backups created before this time are listed. time-range-upper-bound is exclusive.

--exclusive-start-backup-arn (string)

LastEvaluatedBackupARN returned by the previous list-backups call.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

BackupSummaries -> (list)

List of BackupSummary objects.

(structure)

Contains details for the backup.

TableName -> (string)

Name of the table.

TableId -> (string)

Unique identifier for the table.

TableArn -> (string)

ARN associated with the table.

BackupArn -> (string)

ARN associated with the backup.

BackupName -> (string)

Name of the specified backup.

BackupCreationDateTime -> (timestamp)

Time at which the backup was created.

BackupStatus -> (string)

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

BackupSizeBytes -> (long)

Size of the backup in bytes.

LastEvaluatedBackupArn -> (string)

Last evaluated BackupARN.