Class: Aws::FSx::Types::DescribeSnapshotsRequest

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 DescribeSnapshotsRequest data as a hash:

{
  snapshot_ids: ["SnapshotId"],
  filters: [
    {
      name: "file-system-id", # accepts file-system-id, volume-id
      values: ["SnapshotFilterValue"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::SnapshotFilter>

The filters structure. The supported names are file-system-id or volume-id.

Returns:



4842
4843
4844
4845
4846
4847
4848
4849
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4842

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

#max_resultsInteger

The maximum number of resources to return in the response. This value must be an integer greater than zero.

Returns:

  • (Integer)


4842
4843
4844
4845
4846
4847
4848
4849
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4842

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

#next_tokenString

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

Returns:

  • (String)


4842
4843
4844
4845
4846
4847
4848
4849
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4842

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

#snapshot_idsArray<String>

The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.

Returns:

  • (Array<String>)


4842
4843
4844
4845
4846
4847
4848
4849
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4842

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