GET /#Action=DescribeVolumes

Describes the specified EBS volumes or all of your EBS volumes.

If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.

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

Servers

https://ec2.{region}.amazonaws.com
https://ec2.amazonaws.com
https://ec2.{region}.amazonaws.com.cn

Request headers

Name	Type	Required
`X-Amz-Content-Sha256`	String	No
`X-Amz-Credential`	String	No
`X-Amz-Date`	String	No
`X-Amz-Algorithm`	String	No
`X-Amz-SignedHeaders`	String	No
`X-Amz-Security-Token`	String	No
`X-Amz-Signature`	String	No

Query parameters

Name	Type	Required	Description
`Filter[]`	Array	No	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`:<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 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`)
`Version`	String	Yes	Possible values: `"2016-11-15"`
`MaxResults`	Integer	No	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.
`NextToken`	String	No	The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.
`VolumeId[]`	Array	No	The volume IDs.
`DryRun`	Boolean	No	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`.
`Action`	String	Yes	Possible values: `"DescribeVolumes"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.