describe-volumes¶

Description¶

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 about user permissions, see Managing User Permissions .

Synopsis¶

  describe-volumes
[--instance-id <value>]
[--stack-id <value>]
[--raid-array-id <value>]
[--volume-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--instance-id (string)

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

--stack-id (string)

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

--raid-array-id (string)

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

--volume-ids (list)

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.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To describe a stack’s volumes

The following example describes a stack’s EBS volumes.

aws opsworks --region us-east-1 describe-volumes --stack-id 8c428b08-a1a1-46ce-a5f8-feddc43771b8

Output:

{
  "Volumes": [
    {
      "Status": "in-use",
      "AvailabilityZone": "us-west-2a",
      "Name": "CLITest",
      "InstanceId": "dfe18b02-5327-493d-91a4-c5c0c448927f",
      "VolumeType": "standard",
      "VolumeId": "56b66fbd-e1a1-4aff-9227-70f77118d4c5",
      "Device": "/dev/sdi",
      "Ec2VolumeId": "vol-295c1638",
      "MountPoint": "/mnt/myvolume",
      "Size": 1
    }
  ]
}

More Information

For more information, see Resource Management in the AWS OpsWorks User Guide.

Output¶

Volumes -> (list)

An array of volume IDs.

(structure)

Describes an instance’s Amazon EBS volume.

VolumeId -> (string)

The volume ID.

Ec2VolumeId -> (string)

The Amazon EC2 volume ID.

Name -> (string)

The volume name.

RaidArrayId -> (string)

The RAID array ID.

InstanceId -> (string)

The instance ID.

Status -> (string)

The value returned by DescribeVolumes .

Size -> (integer)

The volume size.

Device -> (string)

The device name.

MountPoint -> (string)

The volume mount point. For example, “/mnt/disk1”.

Region -> (string)

The AWS region. For more information about AWS regions, see Regions and Endpoints .

AvailabilityZone -> (string)

The volume Availability Zone. For more information, see Regions and Endpoints .

VolumeType -> (string)

The volume type. For more information, see Amazon EBS Volume Types .

standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.

io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.

gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.

st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

Iops -> (integer)

For PIOPS volumes, the IOPS per disk.

Encrypted -> (boolean)

Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption .

Table of Contents

Feedback

User Guide