Class: Aws::EC2::Types::DescribeVolumesRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribeVolumesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #filters ⇒ Array<Types::Filter>

  The filters.

• #max_results ⇒ Integer

  The maximum number of volumes to return for this request.

• #next_token ⇒ String

  The token returned from a previous paginated request.

• #volume_ids ⇒ Array<String>

  The volume IDs.

Instance Attribute Details

#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 26941

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

#filters ⇒ Array<Types::Filter>

The filters.

• ‘attachment.attach-time` - The time stamp when the attachment initiated.

• ‘attachment.delete-on-termination` - Whether the volume is deleted on instance termination.

• ‘attachment.device` - The device name specified in the block device mapping (for example, `/dev/sda1`).

• ‘attachment.instance-id` - The ID of the instance the volume is attached to.

• ‘attachment.status` - The attachment state (`attaching` | `attached` | `detaching`).

• ‘availability-zone` - The Availability Zone in which the volume was created.

• ‘create-time` - The time stamp when the volume was created.

• ‘encrypted` - Indicates whether the volume is encrypted (`true` | `false`)

• ‘multi-attach-enabled` - Indicates whether the volume is enabled for Multi-Attach (`true` | `false`)

• ‘fast-restored` - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (`true` | `false`).

• ‘size` - The size of the volume, in GiB.

• ‘snapshot-id` - The snapshot from which the volume was created.

• ‘status` - The state of the volume (`creating` | `available` | `in-use` | `deleting` | `deleted` | `error`).

• ‘tag`:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

• ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• ‘volume-id` - The volume ID.

• ‘volume-type` - The Amazon EBS volume type (`gp2` | `gp3` | `io1` | `io2` | `st1` | `sc1`| `standard`)

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-ec2/types.rb', line 26941

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

#max_results ⇒ Integer

The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see [Pagination].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 26941

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

#next_token ⇒ String

The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 26941

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

#volume_ids ⇒ Array<String>

The volume IDs.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 26941

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