Network.AWS.EC2.DescribeVolumes

Describes the specified Amazon EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeVolumes.html

Request

data DescribeVolumes

Instances

Eq DescribeVolumes

Read DescribeVolumes

Show DescribeVolumes

AWSRequest DescribeVolumes

ToQuery DescribeVolumes

ToPath DescribeVolumes

ToHeaders DescribeVolumes

type Sv DescribeVolumes = EC2

type Rs DescribeVolumes = DescribeVolumesResponse

Request constructor

describeVolumes :: DescribeVolumes

DescribeVolumes constructor.

The fields accessible through corresponding lenses are:

• dv2DryRun :: Maybe Bool
• dv2Filters :: [Filter]
• dv2MaxResults :: Maybe Int
• dv2NextToken :: Maybe Text
• dv2VolumeIds :: [Text]

Request lenses

dv2DryRun :: Lens' DescribeVolumes (Maybe Bool)

dv2Filters :: Lens' DescribeVolumes [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 that is exposed to the instance (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 | detached).

'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:key=value - The key/value combination of a tag assigned to the resource.

'tag-key' - The key of a tag assigned to the resource. This filter is independent of the 'tag-value' filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

'tag-value' - The value of a tag assigned to the resource. This filter is independent of the 'tag-key' filter.

'volume-id' - The volume ID.

'volume-type' - The Amazon EBS volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

dv2MaxResults :: Lens' DescribeVolumes (Maybe Int)

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 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results.

dv2NextToken :: Lens' DescribeVolumes (Maybe Text)

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.

dv2VolumeIds :: Lens' DescribeVolumes [Text]

One or more volume IDs.

Response

data DescribeVolumesResponse

Instances

Eq DescribeVolumesResponse

Read DescribeVolumesResponse

Show DescribeVolumesResponse

FromXML DescribeVolumesResponse

Response constructor

describeVolumesResponse :: DescribeVolumesResponse

DescribeVolumesResponse constructor.

The fields accessible through corresponding lenses are:

• dvrNextToken :: Maybe Text
• dvrVolumes :: [Volume]

Response lenses

dvrNextToken :: Lens' DescribeVolumesResponse (Maybe Text)

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

dvrVolumes :: Lens' DescribeVolumesResponse [Volume]