Skip to content
AWS for Query.Farm

aws.lightsail.get_disk_snapshot

Example SQL Queries

SELECT * FROM
aws.lightsail.get_disk_snapshot
WHERE
"disk_snapshot_name" = 'VALUE';

Description

Returns information about a specific block storage disk snapshot.

Table Definition

Column NameColumn Data Type
disk_snapshot_name Required Input Column

The name of the disk snapshot (my-disk-snapshot).

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
disk_snapshot

An object containing information about the disk snapshot.

STRUCT(
    "name" VARCHAR,
    "arn" VARCHAR,
    "support_code" VARCHAR,
    "created_at" TIMESTAMP_S,
    "location" STRUCT(
        "availability_zone" VARCHAR,
        "region_name" VARCHAR
    ),
    "resource_type" VARCHAR,
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "size_in_gb" BIGINT,
    "state" VARCHAR,
    "progress" VARCHAR,
    "from_disk_name" VARCHAR,
    "from_disk_arn" VARCHAR,
    "from_instance_name" VARCHAR,
    "from_instance_arn" VARCHAR,
    "is_from_auto_snapshot" BOOLEAN
)
Show child fields
disk_snapshot.arn

The Amazon Resource Name (ARN) of the disk snapshot.

disk_snapshot.created_at

The date when the disk snapshot was created.

disk_snapshot.from_disk_arn

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.

disk_snapshot.from_disk_name

The unique name of the source disk from which the disk snapshot was created.

disk_snapshot.from_instance_arn

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.

disk_snapshot.from_instance_name

The unique name of the source instance from which the disk (system volume) snapshot was created.

disk_snapshot.is_from_auto_snapshot

A Boolean value indicating whether the snapshot was created from an automatic snapshot.

disk_snapshot.location

The AWS Region and Availability Zone where the disk snapshot was created.

Show child fields
disk_snapshot.location.availability_zone

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

disk_snapshot.location.region_name

The Amazon Web Services Region name.

disk_snapshot.name

The name of the disk snapshot (my-disk-snapshot).

disk_snapshot.progress

The progress of the snapshot.

disk_snapshot.resource_type

The Lightsail resource type (DiskSnapshot).

disk_snapshot.size_in_gb

The size of the disk in GB.

disk_snapshot.state

The status of the disk snapshot operation.

disk_snapshot.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.

disk_snapshot.tags[]
Show child fields
disk_snapshot.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: + - = . _ :/@

disk_snapshot.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: + - = . _ :/@