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

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

Overview

Note:

When making an API call, you may pass DescribeVolumesRequest data as a hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  volume_ids: ["String"],
  dry_run: false,
  max_results: 1,
  next_token: "String",
}

Contains the parameters for DescribeVolumes.

See Also:

Instance Attribute Summary collapse

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) 


16353
16354
16355
16356
16357
16358
16359
16360
 
# File 'lib/aws-sdk-ec2/types.rb', line 16353

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

#filters ⇒ Array<Types::Filter>

One or more 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` - The encryption status of the volume.

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

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

  • ‘status` - The status 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. This can be `gp2` for General Purpose SSD, `io1` for Provisioned IOPS SSD, `st1` for Throughput Optimized HDD, `sc1` for Cold HDD, or `standard` for Magnetic volumes.

Returns:



16353
16354
16355
16356
16357
16358
16359
16360
 
# File 'lib/aws-sdk-ec2/types.rb', line 16353

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

#max_results ⇒ Integer

The maximum number of volume results returned by ‘DescribeVolumes` in paginated output. When this parameter is used, `DescribeVolumes` only returns `MaxResults` results in a single page along with a `NextToken` response element. The remaining results of the initial request can be seen by sending another `DescribeVolumes` request with the returned `NextToken` value. This value can be between 5 and 500; if `MaxResults` is given a value larger than 500, only 500 results are returned. If this parameter is not used, then `DescribeVolumes` returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

Returns:

  • (Integer) 


16353
16354
16355
16356
16357
16358
16359
16360
 
# File 'lib/aws-sdk-ec2/types.rb', line 16353

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

#next_token ⇒ String

The ‘NextToken` value returned from a previous paginated `DescribeVolumes` request where `MaxResults` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `NextToken` value. This value is `null` when there are no more results to return.

Returns:

  • (String) 


16353
16354
16355
16356
16357
16358
16359
16360
 
# File 'lib/aws-sdk-ec2/types.rb', line 16353

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

#volume_ids ⇒ Array<String>

One or more volume IDs.

Returns:

  • (Array<String>) 


16353
16354
16355
16356
16357
16358
16359
16360
 
# File 'lib/aws-sdk-ec2/types.rb', line 16353

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