Class: Aws::FSx::Types::DescribeVolumesRequest

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

{
  volume_ids: ["VolumeId"],
  filters: [
    {
      name: "file-system-id", # accepts file-system-id, storage-virtual-machine-id
      values: ["VolumeFilterValue"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::VolumeFilter>

Enter a filter Name and Values pair to view a select set of volumes.

Returns:



4831
4832
4833
4834
4835
4836
4837
4838
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4831

class DescribeVolumesRequest < Struct.new(
  :volume_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)


4831
4832
4833
4834
4835
4836
4837
4838
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4831

class DescribeVolumesRequest < Struct.new(
  :volume_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)


4831
4832
4833
4834
4835
4836
4837
4838
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4831

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

#volume_idsArray<String>

The IDs of the volumes whose descriptions you want to retrieve.

Returns:

  • (Array<String>)


4831
4832
4833
4834
4835
4836
4837
4838
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4831

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