Returns the description of specific Amazon FSx for Windows File Server
backups, if a BackupIds value is provided for that backup. Otherwise,
it returns all backups owned by your AWS account in the AWS Region of
the endpoint that you're calling.
fsx_describe_backups(BackupIds, Filters, MaxResults, NextToken)(Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.
(Optional) Filters structure. Supported names are file-system-id and backup-type.
(Optional) Maximum number of backups to return in the response
(integer). 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) Opaque pagination token returned from a previous
DescribeBackups operation (String). If a token present, the action
continues the list from where the returning call left off.
svc$describe_backups(
BackupIds = list(
"string"
),
Filters = list(
list(
Name = "file-system-id"|"backup-type",
Values = list(
"string"
)
)
),
MaxResults = 123,
NextToken = "string"
)
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 NextToken from the last response.
This action is used in an iterative process to retrieve a list of your
backups. DescribeBackups is called first without a NextTokenvalue.
Then the action continues to be called with the NextToken parameter
set to the value of the last NextToken value until a response has no
NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system
descriptions while still including a NextToken value.
The order of backups returned in the response of one
DescribeBackups call and the order of backups returned across the
responses of a multi-call iteration is unspecified.
# NOT RUN {
# This operation describes all of the Amazon FSx backups in an account.
# }
# NOT RUN {
svc$describe_backups()
# }
# NOT RUN {
# }
Run the code above in your browser using DataCamp Workspace