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.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- DryRun
-
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 isUnauthorizedOperation
.Type: Boolean
Required: No
- Filter.N
-
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
:<key> - 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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.
Type: Array of Filter objects
Required: No
-
- MaxResults
-
The maximum number of volume results returned by
DescribeVolumes
in paginated output. When this parameter is used,DescribeVolumes
only returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeVolumes
request with the returnedNextToken
value. This value can be between 5 and 500; ifMaxResults
is given a value larger than 500, only 500 results are returned. If this parameter is not used, thenDescribeVolumes
returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.Type: Integer
Required: No
- NextToken
-
The
NextToken
value returned from a previous paginatedDescribeVolumes
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.Type: String
Required: No
- VolumeId.N
-
One or more volume IDs.
Type: Array of strings
Required: No
Response Elements
The following elements are returned by the service.
- nextToken
-
The
NextToken
value to include in a futureDescribeVolumes
request. When the results of aDescribeVolumes
request exceedMaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.Type: String
- requestId
-
The ID of the request.
Type: String
- volumeSet
-
Information about the volumes.
Type: Array of Volume objects
Errors
For information about the errors that are common to all actions, see Common Client Errors.
Example
Example
This example describes all volumes associated with your account.
Sample Request
https://ec2.amazonaws.com/?Action=DescribeVolumes &AUTHPARAMS
Sample Response
<DescribeVolumesResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <volumeSet> <item> <volumeId>vol-1234567890abcdef0</volumeId> <size>80</size> <snapshotId/> <availabilityZone>us-east-1a</availabilityZone> <status>in-use</status> <createTime>YYYY-MM-DDTHH:MM:SS.SSSZ</createTime> <attachmentSet> <item> <volumeId>vol-1234567890abcdef0</volumeId> <instanceId>i-1234567890abcdef0</instanceId> <device>/dev/sdh</device> <status>attached</status> <attachTime>YYYY-MM-DDTHH:MM:SS.SSSZ</attachTime> <deleteOnTermination>false</deleteOnTermination> </item> </attachmentSet> <volumeType>standard</volumeType> <encrypted>true</encrypted> </item> </volumeSet> </DescribeVolumesResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: