You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::FSx::Types::DescribeBackupsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeBackupsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  backup_ids: ["BackupId"],
  filters: [
    {
      name: "file-system-id", # accepts file-system-id, backup-type
      values: ["FilterValue"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

The request object for DescribeBackups operation.

Instance Attribute Summary collapse

Instance Attribute Details

#backup_idsArray<String>

(Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Returns:

  • (Array<String>)

    (Optional) IDs of the backups you want to retrieve (String).

#filtersArray<Types::Filter>

(Optional) Filters structure. Supported names are file-system-id and backup-type.

Returns:

#max_resultsInteger

(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.

Returns:

  • (Integer)

    (Optional) Maximum number of backups to return in the response (integer).

#next_tokenString

(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.

Returns:

  • (String)

    (Optional) Opaque pagination token returned from a previous DescribeBackups operation (String).