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.

list-backups is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: BackupSummaries

Synopsis

  list-backups
[--table-name <value>]
[--time-range-lower-bound <value>]
[--time-range-upper-bound <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--table-name (string)

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

--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.

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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.