Skip to contents

Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that backup

Source: R/fsx_operations.R
fsx_describe_backups.Rd

Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

See https://www.paws-r-sdk.com/docs/fsx_describe_backups/ for full documentation.

Usage

fsx_describe_backups(
  BackupIds = NULL,
  Filters = NULL,
  MaxResults = NULL,
  NextToken = NULL
)

Arguments

BackupIds

The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

Filters

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

MaxResults

Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

NextToken

An opaque pagination token returned from a previous describe_backups operation. If a token is present, the operation continues the list from where the returning call left off.