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

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::DescribeSnapshotsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-fsx/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filters ⇒ Array<Types::SnapshotFilter>

  The filters structure.

• #include_shared ⇒ Boolean

  Set to ‘false` (default) if you want to only see the snapshots in your Amazon Web Services account.

• #max_results ⇒ Integer

  The maximum number of resources to return in the response.

• #next_token ⇒ String

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

• #snapshot_ids ⇒ Array<String>

  The IDs of the snapshots that you want to retrieve.

Instance Attribute Details

#filters ⇒ Array<Types::SnapshotFilter>

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

Returns:

• (Array<Types::SnapshotFilter>)

# File 'lib/aws-sdk-fsx/types.rb', line 5021

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

#include_shared ⇒ Boolean

Set to ‘false` (default) if you want to only see the snapshots in 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)

# File 'lib/aws-sdk-fsx/types.rb', line 5021

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

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-fsx/types.rb', line 5021

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

#next_token ⇒ String

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

# File 'lib/aws-sdk-fsx/types.rb', line 5021

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

#snapshot_ids ⇒ Array<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>)

# File 'lib/aws-sdk-fsx/types.rb', line 5021

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