Delete Volume operation for the Amazon EC2 REST adapter
The Delete Volume operation enables you to delete an Amazon EBS volume that you own.
The following figure shows a sample <items> XML element for the Delete Volume operation.
Sample <items> XML element for the Delete Volume operation
<item>
<parameters>
<volume-id></volume-id>
</parameters>
</item>
</items>
The following table shows adapter request elements for the Delete Volume operation.
Adapter request elements for the Delete Volume operation
Element | Definition | Required |
---|---|---|
<access-key> | Specifies the Amazon Web Services (AWS) access key You need to generate the AWS access key by going to the Security Credentials tab in the AWS console. | Conditional;
|
<secret-key> | Specifies the AWS secret access key You need to generate the AWS secret access key by going to the Security Credentials tab in the AWS console. | Conditional;
|
<session-token> | Specifies the temporary session token generated using the AWS APIs. | Conditional; You must specify the Access Key and Secret Key as well in the configuration or the adapter request, else the <session-token> value is ignored. |
<region> | Specifies the region with which you want the adapter to communicate Amazon EC2 is hosted in multiple locations world-wide. You must specify the region in which you want the adapter to perform the actions. Valid values:
| No |
<operation-name> | Contains the name of the operation: delete-volume | Yes |
<volume-id> | Specifies the ID of the Amazon EBS volume to delete | Yes |
The following figure shows a sample adapter request for the Delete Volume operation.
Sample adapter request for the Delete Volume operation
<operation-name>delete-volume</operation-name>
<parameters>
<volume-id>vol-ae822d86</volume-id>
</parameters>
</amazon-ec2-rest-request>
The following figure shows a sample adapter response for the Delete Volume operation.
Sample adapter response for the Delete Volume operation
<metadata>
<status>success</status>
</metadata>
<DeleteVolumeResponse>
<return>true</return>
</DeleteVolumeResponse>
</amazon-ec2-rest-response>