/AWS1/CL_FSX=>DESCRIBEBACKUPS()
¶
About DescribeBackups¶
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.
When retrieving all backups, you can optionally specify the MaxResults
parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken
value in the response. In this case,
send a later request with the NextToken
request parameter set to the value
of the NextToken
value from the last response.
This operation is used in an iterative process to retrieve a list of your backups.
DescribeBackups
is called first without a NextToken
value.
Then the operation continues to be called with the NextToken
parameter set
to the value of the last NextToken
value until a response has no
NextToken
value.
When using this operation, keep the following in mind:
-
The operation might return fewer than the
MaxResults
value of backup descriptions while still including aNextToken
value. -
The order of the backups returned in the response of one
DescribeBackups
call and the order of the backups returned across the responses of a multi-call iteration is unspecified.
Method Signature¶
IMPORTING¶
Optional arguments:¶
IT_BACKUPIDS
TYPE /AWS1/CL_FSXBACKUPIDS_W=>TT_BACKUPIDS
TT_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.
IT_FILTERS
TYPE /AWS1/CL_FSXFILTER=>TT_FILTERS
TT_FILTERS
¶
The filters structure. The supported names are
file-system-id
,backup-type
,file-system-type
, andvolume-id
.
IV_MAXRESULTS
TYPE /AWS1/FSXMAXRESULTS
/AWS1/FSXMAXRESULTS
¶
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.
IV_NEXTTOKEN
TYPE /AWS1/FSXNEXTTOKEN
/AWS1/FSXNEXTTOKEN
¶
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.