Network.AWS.EC2.DescribeVolumes

Describes the specified 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 EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide .

This operation returns paginated results.

Creating a Request

describeVolumes :: DescribeVolumes

Creates a value of DescribeVolumes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• desFilters - 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, devsda1 ). * 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 :key =value - The keyvalue combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value. * 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, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
• desVolumeIds - One or more volume IDs.
• desNextToken - 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.
• desDryRun - 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 .
• desMaxResults - 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.

data DescribeVolumes

Contains the parameters for DescribeVolumes.

See: describeVolumes smart constructor.

Instances

Eq DescribeVolumes

Methods

(==) :: DescribeVolumes -> DescribeVolumes -> Bool

(/=) :: DescribeVolumes -> DescribeVolumes -> Bool

Data DescribeVolumes

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeVolumes -> c DescribeVolumes

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeVolumes

toConstr :: DescribeVolumes -> Constr

dataTypeOf :: DescribeVolumes -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeVolumes)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeVolumes)

gmapT :: (forall b. Data b => b -> b) -> DescribeVolumes -> DescribeVolumes

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeVolumes -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeVolumes -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeVolumes -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeVolumes -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeVolumes -> m DescribeVolumes

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeVolumes -> m DescribeVolumes

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeVolumes -> m DescribeVolumes

Read DescribeVolumes

Methods

readsPrec :: Int -> ReadS DescribeVolumes

readList :: ReadS [DescribeVolumes]

readPrec :: ReadPrec DescribeVolumes

readListPrec :: ReadPrec [DescribeVolumes]

Show DescribeVolumes

Methods

showsPrec :: Int -> DescribeVolumes -> ShowS

show :: DescribeVolumes -> String

showList :: [DescribeVolumes] -> ShowS

Generic DescribeVolumes

Associated Types

type Rep DescribeVolumes :: * -> *

Methods

from :: DescribeVolumes -> Rep DescribeVolumes x

to :: Rep DescribeVolumes x -> DescribeVolumes

Hashable DescribeVolumes

Methods

hashWithSalt :: Int -> DescribeVolumes -> Int

hash :: DescribeVolumes -> Int

NFData DescribeVolumes

Methods

rnf :: DescribeVolumes -> ()

AWSPager DescribeVolumes

Methods

page :: DescribeVolumes -> Rs DescribeVolumes -> Maybe DescribeVolumes

AWSRequest DescribeVolumes

Associated Types

type Rs DescribeVolumes :: *

Methods

request :: DescribeVolumes -> Request DescribeVolumes

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeVolumes -> ClientResponse -> m (Response DescribeVolumes)

ToHeaders DescribeVolumes

Methods

toHeaders :: DescribeVolumes -> [Header]

ToPath DescribeVolumes

Methods

toPath :: DescribeVolumes -> ByteString

ToQuery DescribeVolumes

Methods

toQuery :: DescribeVolumes -> QueryString

type Rep DescribeVolumes

type Rep DescribeVolumes = D1 * (MetaData "DescribeVolumes" "Network.AWS.EC2.DescribeVolumes" "amazonka-ec2-1.6.0-Kkew7Kpgof6EYi20Z0WOzs" False) (C1 * (MetaCons "DescribeVolumes'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_desFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Filter]))) (S1 * (MetaSel (Just Symbol "_desVolumeIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_desNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_desDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_desMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))))

type Rs DescribeVolumes

type Rs DescribeVolumes = DescribeVolumesResponse

Request Lenses

desFilters :: 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 specified in the block device mapping (for example, devsda1 ). * 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 :key =value - The keyvalue combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value. * 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, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

desVolumeIds :: Lens' DescribeVolumes [Text]

One or more volume IDs.

desNextToken :: 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.

desDryRun :: Lens' DescribeVolumes (Maybe Bool)

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 .

desMaxResults :: 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 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.

Destructuring the Response

describeVolumesResponse

Arguments

:: Int

dvvrsResponseStatus

-> DescribeVolumesResponse

Creates a value of DescribeVolumesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dvvrsNextToken - 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.
• dvvrsVolumes - Information about the volumes.
• dvvrsResponseStatus - -- | The response status code.

data DescribeVolumesResponse

Contains the output of DescribeVolumes.

See: describeVolumesResponse smart constructor.

Instances

Eq DescribeVolumesResponse

Methods

(==) :: DescribeVolumesResponse -> DescribeVolumesResponse -> Bool

(/=) :: DescribeVolumesResponse -> DescribeVolumesResponse -> Bool

Data DescribeVolumesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeVolumesResponse -> c DescribeVolumesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeVolumesResponse

toConstr :: DescribeVolumesResponse -> Constr

dataTypeOf :: DescribeVolumesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeVolumesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeVolumesResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeVolumesResponse -> DescribeVolumesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeVolumesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeVolumesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeVolumesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeVolumesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeVolumesResponse -> m DescribeVolumesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeVolumesResponse -> m DescribeVolumesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeVolumesResponse -> m DescribeVolumesResponse

Read DescribeVolumesResponse

Methods

readsPrec :: Int -> ReadS DescribeVolumesResponse

readList :: ReadS [DescribeVolumesResponse]

readPrec :: ReadPrec DescribeVolumesResponse

readListPrec :: ReadPrec [DescribeVolumesResponse]

Show DescribeVolumesResponse

Methods

showsPrec :: Int -> DescribeVolumesResponse -> ShowS

show :: DescribeVolumesResponse -> String

showList :: [DescribeVolumesResponse] -> ShowS

Generic DescribeVolumesResponse

Associated Types

type Rep DescribeVolumesResponse :: * -> *

Methods

from :: DescribeVolumesResponse -> Rep DescribeVolumesResponse x

to :: Rep DescribeVolumesResponse x -> DescribeVolumesResponse

NFData DescribeVolumesResponse

Methods

rnf :: DescribeVolumesResponse -> ()

type Rep DescribeVolumesResponse

type Rep DescribeVolumesResponse = D1 * (MetaData "DescribeVolumesResponse" "Network.AWS.EC2.DescribeVolumes" "amazonka-ec2-1.6.0-Kkew7Kpgof6EYi20Z0WOzs" False) (C1 * (MetaCons "DescribeVolumesResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dvvrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dvvrsVolumes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Volume]))) (S1 * (MetaSel (Just Symbol "_dvvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dvvrsNextToken :: 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.

dvvrsVolumes :: Lens' DescribeVolumesResponse [Volume]

Information about the volumes.

dvvrsResponseStatus :: Lens' DescribeVolumesResponse Int

• - | The response status code.