Skip to content

aws.lightsail.get_disks

Example SQL Queries

SELECT * FROM
aws.lightsail.get_disks;

Description

Returns information about all block storage disks in your AWS account and region.

Table Definition

Column NameColumn Data Type
_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
add_ons

An array of objects representing the add-ons enabled on the disk.

STRUCT(
"name" VARCHAR,
"status" VARCHAR,
"snapshot_time_of_day" VARCHAR,
"next_snapshot_time_of_day" VARCHAR,
"threshold" VARCHAR,
"duration" VARCHAR
)[]
Show child fields
add_ons[]
Show child fields
add_ons[].duration

The amount of idle time in minutes after which your virtual computer will automatically stop.

This add-on only applies to Lightsail for Research resources.

add_ons[].name

The name of the add-on.

add_ons[].next_snapshot_time_of_day

The next daily time an automatic snapshot will be created.

The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).

The snapshot is automatically created between the time shown and up to 45 minutes after.

add_ons[].snapshot_time_of_day

The daily time when an automatic snapshot is created.

The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).

The snapshot is automatically created between the time shown and up to 45 minutes after.

add_ons[].status

The status of the add-on.

add_ons[].threshold

The trigger threshold of the action.

This add-on only applies to Lightsail for Research resources.

arn

The Amazon Resource Name (ARN) of the disk.

VARCHAR
attached_to

The resources to which the disk is attached.

VARCHAR
attachment_state

(Discontinued) The attachment state of the disk.

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now discontinued, but still included in the response. Use isAttached instead.

VARCHAR
auto_mount_status

The status of automatically mounting a storage disk to a virtual computer.

This parameter only applies to Lightsail for Research resources.

VARCHAR
created_at

The date when the disk was created.

TIMESTAMP_S
gb_in_use

(Discontinued) The number of GB in use by the disk.

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.

BIGINT
iops

The input/output operations per second (IOPS) of the disk.

BIGINT
is_attached

A Boolean value indicating whether the disk is attached.

BOOLEAN
is_system_disk

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

BOOLEAN
location

The AWS Region and Availability Zone where the disk is located.

STRUCT(
"availability_zone" VARCHAR,
"region_name" VARCHAR
)
Show child fields
location.availability_zone

The Availability Zone. Follows the format us-east-2a (case-sensitive).

location.region_name

The Amazon Web Services Region name.

name

The unique name of the disk.

VARCHAR
path

The disk path.

VARCHAR
resource_type

The Lightsail resource type (Disk).

VARCHAR
size_in_gb

The size of the disk in GB.

BIGINT
state

Describes the status of the disk.

VARCHAR
support_code

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

VARCHAR
tags

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
Show child fields
tags[]
Show child fields
tags[].key

The key of the tag.

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ :/@

tags[].value

The value of the tag.

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ :/@