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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

Note:

When making an API call, you may pass DescribeBackupsRequest data as a hash:

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

The request object for the DescribeBackups operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_idsArray<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.

Returns:

  • (Array<String>)


4500
4501
4502
4503
4504
4505
4506
4507
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4500

class DescribeBackupsRequest < Struct.new(
  :backup_ids,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

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

Returns:



4500
4501
4502
4503
4504
4505
4506
4507
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4500

class DescribeBackupsRequest < Struct.new(
  :backup_ids,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


4500
4501
4502
4503
4504
4505
4506
4507
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4500

class DescribeBackupsRequest < Struct.new(
  :backup_ids,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


4500
4501
4502
4503
4504
4505
4506
4507
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4500

class DescribeBackupsRequest < Struct.new(
  :backup_ids,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end