• Public
  • Public/Protected
  • All

Interface DescribeBackupsRequest

The request object for the DescribeBackups operation.




Optional BackupIds

BackupIds: string[]

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.

Optional Filters

Filters: Filter[]

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

Optional MaxResults

MaxResults: undefined | number

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.

Optional NextToken

NextToken: undefined | string

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