Describe Volumes operation


The Describe Volumes operation describes the specified Amazon EBS volumes that you own. If you do not specify one or more volume IDs, this operation describes all the volumes that you own.

The following figure shows a sample <items> XML element for the Describe Volumes operation. 

Sample <items> XML element for the Describe Volumes operation

<items>
   <item>
       <parameters>
           <volume-set>
               <!--Zero or more repetition-->
               <item>
                   <volume-id></volume-id>
               </item>
           </volume-set>
       </parameters>
   </item>
</items>

The following table shows adapter request elements for the Describe Volumes operation. 

Adapter request elements for the Describe Volumes operation

Element

Definition

Required

<wsdl-location>

Specifies the target Web Service Description Language (WSDL) URL for Amazon EC2

Examples:

Conditional:

  • Required if not specified in the request
  • If specified in the configuration and request, the value in the request overrides the value in the configuration
<endpoint-address>

Specifies the web service endpoint for the adapter to use while performing operations on Amazon EC2 instances across different regions
Default value: US East region: http://us-east-1.ec2.amazonaws.com/

No

<signature-properties>

Specifies the mode for signing the adapter request

Failed to execute the [panel] macro.

Conditional:

  • Required if not specified in the configuration
  • If <signature-properties mode = "key-files">, requires <private-key-file>
     and <certificate-file>
  • If <signature-properties mode = "key-data">, requires <private-key-data> and <certificate-data> 

    Failed to execute the [panel] macro.

<operation-name>

Contains the name of the operation: describe-volumes

Yes

<volume-set>

Specifies the set of Amazon EBS volumes to be described

No

<volume-id>

Specifies the ID of the Amazon EBS volume to be described

No

The following figure shows a sample adapter request for the Describe Volumes operation. 

Sample adapter request for the Describe Volumes operation

<amazon-ec2-request>
   <wsdl-location>http://ec2.amazonaws.com/doc/2009-11-30/</wsdl-location>
   <endpoint-address>http://us-east-1.ec2.amazonaws.com/</endpoint-address>
   <signature-properties mode = "key-files">
       <private-key-file>C:\Security\
pk-MJ5GIUNLM2XJ3VRJSYTKOFDWILELDQHB.PEM</private-key-file>
       <certificate-file>C:\Security\
cert-MJ5GIUNLM2XJ3VRJSYTKOFDWILELDQHB.PEM</certificate-file>
   </signature-properties>
   <operation-name>describe-volumes</operation-name>
   <parameters>
       <volume-set>
           <!--Zero or more repetition-->
           <item>
               <volume-id>vol-e14fec88</volume-id>
           </item>
       </volume-set>
   </parameters>
</amazon-ec2-request>

The following figure shows a sample adapter response for the Describe Volumes operation. 

Sample adapter response for the Describe Volumes operation

<amazon-ec2-response>
   <metadata>
       <status>success</status>
   </metadata>
   <DescribeVolumesResponse>
       <requestId>ec0fd56d-b878-45b4-8d03-09e42e024cdb</requestId>
       <volumeSet>
           <item>
               <volumeId>vol-e14fec88</volumeId>
               <size>15</size>
               <snapshotId>snap-cfa2b8a6</snapshotId>
               <availabilityZone>us-east-1a</availabilityZone>
               <status>available</status>
               <createTime>2010-03-31T08:14:49.000Z</createTime>
               <attachmentSet/>
           </item>
       </volumeSet>
   </DescribeVolumesResponse>
</amazon-ec2-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*