Menu
AWS OpsWorks
API Reference (API Version 2013-02-18)

DescribeVolumes

Describes an instance's Amazon EBS volumes.

Note

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Request Syntax

{
   "InstanceId": "string",
   "RaidArrayId": "string",
   "StackId": "string",
   "VolumeIds": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

InstanceId

The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

Type: String

Required: No

RaidArrayId

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

Type: String

Required: No

StackId

A stack ID. The action describes the stack's registered Amazon EBS volumes.

Type: String

Required: No

VolumeIds

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

Type: Array of strings

Required: No

Response Syntax

{
   "Volumes": [ 
      { 
         "AvailabilityZone": "string",
         "Device": "string",
         "Ec2VolumeId": "string",
         "InstanceId": "string",
         "Iops": number,
         "MountPoint": "string",
         "Name": "string",
         "RaidArrayId": "string",
         "Region": "string",
         "Size": number,
         "Status": "string",
         "VolumeId": "string",
         "VolumeType": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Volumes

An array of volume IDs.

Type: Array of Volume objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

Indicates that a resource was not found.

HTTP Status Code: 400

ValidationException

Indicates that a request was not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: