Describe Volumes

opsworks_describe_volumes

R Documentation

Describes an instance's Amazon EBS volumes

Description

Describes an instance's Amazon EBS volumes.

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.

Usage

opsworks_describe_volumes(InstanceId, StackId, RaidArrayId, VolumeIds)

Arguments

InstanceId

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

StackId

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

RaidArrayId

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

VolumeIds

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

Value

A list with the following syntax:

list(
  Volumes = list(
    list(
      VolumeId = "string",
      Ec2VolumeId = "string",
      Name = "string",
      RaidArrayId = "string",
      InstanceId = "string",
      Status = "string",
      Size = 123,
      Device = "string",
      MountPoint = "string",
      Region = "string",
      AvailabilityZone = "string",
      VolumeType = "string",
      Iops = 123,
      Encrypted = TRUE|FALSE
    )
  )
)

Request syntax

svc$describe_volumes(
  InstanceId = "string",
  StackId = "string",
  RaidArrayId = "string",
  VolumeIds = list(
    "string"
  )
)