Learn R Programming

paws.database (version 0.1.12)

dynamodb_list_backups: List backups associated with an AWS account

Description

List backups associated with an AWS account. To list backups for a given table, specify TableName. list_backups returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a 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 boundaries are for the time at which the original backup was requested.

You can call list_backups a maximum of five times per second.

Usage

dynamodb_list_backups(TableName, Limit, TimeRangeLowerBound,
  TimeRangeUpperBound, ExclusiveStartBackupArn, BackupType)

Value

A list with the following syntax:

list(
  BackupSummaries = list(
    list(
      TableName = "string",
      TableId = "string",
      TableArn = "string",
      BackupArn = "string",
      BackupName = "string",
      BackupCreationDateTime = as.POSIXct(
        "2015-01-01"
      ),
      BackupExpiryDateTime = as.POSIXct(
        "2015-01-01"
      ),
      BackupStatus = "CREATING"|"DELETED"|"AVAILABLE",
      BackupType = "USER"|"SYSTEM"|"AWS_BACKUP",
      BackupSizeBytes = 123
    )
  ),
  LastEvaluatedBackupArn = "string"
)

Arguments

TableName

The backups from the table specified by TableName are listed.

Limit

Maximum number of backups to return at once.

TimeRangeLowerBound

Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

TimeRangeUpperBound

Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

ExclusiveStartBackupArn

LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new list_backups operation in order to fetch the next page of results.

BackupType

The backups from the table specified by BackupType are listed.

Where BackupType can be:

  • USER - On-demand backup created by you.

  • SYSTEM - On-demand backup automatically created by DynamoDB.

  • ALL - All types of on-demand backups (USER and SYSTEM).

Request syntax

svc$list_backups(
  TableName = "string",
  Limit = 123,
  TimeRangeLowerBound = as.POSIXct(
    "2015-01-01"
  ),
  TimeRangeUpperBound = as.POSIXct(
    "2015-01-01"
  ),
  ExclusiveStartBackupArn = "string",
  BackupType = "USER"|"SYSTEM"|"AWS_BACKUP"|"ALL"
)