Skip to content
AWS for Query.Farm

aws.storagegateway.list_local_disks

Example SQL Queries

SELECT * FROM
aws.storagegateway.list_local_disks
WHERE
"gateway_arn" = 'VALUE';

Description

Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.

The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).

Table Definition

Column NameColumn Data Type
gateway_arn Required Input Column

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

VARCHAR
_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
disks

A JSON object containing the following fields:

STRUCT(
    "disk_id" VARCHAR,
    "disk_path" VARCHAR,
    "disk_node" VARCHAR,
    "disk_status" VARCHAR,
    "disk_size_in_bytes" BIGINT,
    "disk_allocation_type" VARCHAR,
    "disk_allocation_resource" VARCHAR,
    "disk_attribute_list" VARCHAR[]
)[]
Show child fields
disks[]
Show child fields
disks[].disk_allocation_resource

The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId.

disks[].disk_allocation_type

One of the DiskAllocationType enumeration values that identifies how a local disk is used.

Valid Values: UPLOAD_BUFFER | CACHE_STORAGE

disks[].disk_attribute_list[]
disks[].disk_id

The unique device ID or other distinguishing data that identifies a local disk.

disks[].disk_node

The device node of a local disk as assigned by the virtualization environment.

disks[].disk_path

The path of a local disk in the gateway virtual machine (VM).

disks[].disk_size_in_bytes

The local disk size in bytes.

disks[].disk_status

A value that represents the status of a local disk.