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

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

Overview

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:



5048
5049
5050
5051
5052
5053
5054
5055
5056
# File 'lib/aws-sdk-fsx/types.rb', line 5048

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

#include_sharedBoolean

Set to ‘false` (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to `true` if you want to see the snapshots in your account and the ones shared with you from another account.

Returns:

  • (Boolean)


5048
5049
5050
5051
5052
5053
5054
5055
5056
# File 'lib/aws-sdk-fsx/types.rb', line 5048

class DescribeSnapshotsRequest < Struct.new(
  :snapshot_ids,
  :filters,
  :max_results,
  :next_token,
  :include_shared)
  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)


5048
5049
5050
5051
5052
5053
5054
5055
5056
# File 'lib/aws-sdk-fsx/types.rb', line 5048

class DescribeSnapshotsRequest < Struct.new(
  :snapshot_ids,
  :filters,
  :max_results,
  :next_token,
  :include_shared)
  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)


5048
5049
5050
5051
5052
5053
5054
5055
5056
# File 'lib/aws-sdk-fsx/types.rb', line 5048

class DescribeSnapshotsRequest < Struct.new(
  :snapshot_ids,
  :filters,
  :max_results,
  :next_token,
  :include_shared)
  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>)


5048
5049
5050
5051
5052
5053
5054
5055
5056
# File 'lib/aws-sdk-fsx/types.rb', line 5048

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