Skip to content
AWS for Query.Farm

aws.opsworks.describe_volumes

Example SQL Queries

SELECT * FROM
aws.opsworks.describe_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.

Table Definition

Column NameColumn Data Type
instance_id Input Column

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

VARCHAR
raid_array_id Input Column

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

VARCHAR
stack_id Input Column

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

VARCHAR
volume_ids Input Column

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.

VARCHAR[]
Show child fields
volume_ids[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
volumes

An array of volume IDs.

STRUCT(
    "volume_id" VARCHAR,
    "ec2_volume_id" VARCHAR,
    "name" VARCHAR,
    "raid_array_id" VARCHAR,
    "instance_id" VARCHAR,
    "status" VARCHAR,
    "size" BIGINT,
    "device" VARCHAR,
    "mount_point" VARCHAR,
    "region" VARCHAR,
    "availability_zone" VARCHAR,
    "volume_type" VARCHAR,
    "iops" BIGINT,
    "encrypted" BOOLEAN
)[]
Show child fields
volumes[]
Show child fields
volumes[].availability_zone

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

volumes[].device

The device name.

volumes[].ec2_volume_id

The Amazon EC2 volume ID.

volumes[].encrypted

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

volumes[].instance_id

The instance ID.

volumes[].iops

For PIOPS volumes, the IOPS per disk.

volumes[].mount_point

The volume mount point. For example, "/mnt/disk1".

volumes[].name

The volume name. Volume names are a maximum of 128 characters.

volumes[].raid_array_id

The RAID array ID.

volumes[].region

The Amazon Web Services Region. For more information about Amazon Web Services Regions, see Regions and Endpoints.

volumes[].size

The volume size.

volumes[].status

The value returned by DescribeVolumes.

volumes[].volume_id

The volume ID.

volumes[].volume_type

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 125 GiB and a maximum size of 16384 GiB.

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