Skip to content
AWS for Query.Farm

aws.lightsail.get_instance_snapshot

Example SQL Queries

SELECT * FROM
aws.lightsail.get_instance_snapshot
WHERE
"instance_snapshot_name" = 'VALUE';

Description

Returns information about a specific instance snapshot.

Table Definition

Column NameColumn Data Type
instance_snapshot_name Required Input Column

The name of the snapshot for which you are requesting information.

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
instance_snapshot

An array of key-value pairs containing information about the results of your get instance snapshot request.

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
    )[],
    "state" VARCHAR,
    "progress" VARCHAR,
    "from_attached_disks" 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
        )[],
        "add_ons" STRUCT(
            "name" VARCHAR,
            "status" VARCHAR,
            "snapshot_time_of_day" VARCHAR,
            "next_snapshot_time_of_day" VARCHAR,
            "threshold" VARCHAR,
            "duration" VARCHAR
        )[],
        "size_in_gb" BIGINT,
        "is_system_disk" BOOLEAN,
        "iops" BIGINT,
        "path" VARCHAR,
        "state" VARCHAR,
        "attached_to" VARCHAR,
        "is_attached" BOOLEAN,
        "attachment_state" VARCHAR,
        "gb_in_use" BIGINT,
        "auto_mount_status" VARCHAR
    )[],
    "from_instance_name" VARCHAR,
    "from_instance_arn" VARCHAR,
    "from_blueprint_id" VARCHAR,
    "from_bundle_id" VARCHAR,
    "is_from_auto_snapshot" BOOLEAN,
    "size_in_gb" BIGINT
)
Show child fields
instance_snapshot.arn

The Amazon Resource Name (ARN) of the snapshot (arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

instance_snapshot.created_at

The timestamp when the snapshot was created (1479907467.024).

instance_snapshot.from_attached_disks[]
Show child fields
instance_snapshot.from_attached_disks[].add_ons[]
Show child fields
instance_snapshot.from_attached_disks[].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.

instance_snapshot.from_attached_disks[].add_ons[].name

The name of the add-on.

instance_snapshot.from_attached_disks[].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.

instance_snapshot.from_attached_disks[].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.

instance_snapshot.from_attached_disks[].add_ons[].status

The status of the add-on.

instance_snapshot.from_attached_disks[].add_ons[].threshold

The trigger threshold of the action.

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

instance_snapshot.from_attached_disks[].arn

The Amazon Resource Name (ARN) of the disk.

instance_snapshot.from_attached_disks[].attached_to

The resources to which the disk is attached.

instance_snapshot.from_attached_disks[].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.

instance_snapshot.from_attached_disks[].auto_mount_status

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

This parameter only applies to Lightsail for Research resources.

instance_snapshot.from_attached_disks[].created_at

The date when the disk was created.

instance_snapshot.from_attached_disks[].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.

instance_snapshot.from_attached_disks[].iops

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

instance_snapshot.from_attached_disks[].is_attached

A Boolean value indicating whether the disk is attached.

instance_snapshot.from_attached_disks[].is_system_disk

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

instance_snapshot.from_attached_disks[].location

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

Show child fields
instance_snapshot.from_attached_disks[].location.availability_zone

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

instance_snapshot.from_attached_disks[].location.region_name

The Amazon Web Services Region name.

instance_snapshot.from_attached_disks[].name

The unique name of the disk.

instance_snapshot.from_attached_disks[].path

The disk path.

instance_snapshot.from_attached_disks[].resource_type

The Lightsail resource type (Disk).

instance_snapshot.from_attached_disks[].size_in_gb

The size of the disk in GB.

instance_snapshot.from_attached_disks[].state

Describes the status of the disk.

instance_snapshot.from_attached_disks[].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.

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

instance_snapshot.from_attached_disks[].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: + - = . _ :/@

instance_snapshot.from_blueprint_id

The blueprint ID from which you created the snapshot (amazon_linux_2023). A blueprint is a virtual private server (or instance) image used to create instances quickly.

instance_snapshot.from_bundle_id

The bundle ID from which you created the snapshot (micro_x_x).

instance_snapshot.from_instance_arn

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

instance_snapshot.from_instance_name

The instance from which the snapshot was created.

instance_snapshot.is_from_auto_snapshot

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

instance_snapshot.location

The region name and Availability Zone where you created the snapshot.

Show child fields
instance_snapshot.location.availability_zone

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

instance_snapshot.location.region_name

The Amazon Web Services Region name.

instance_snapshot.name

The name of the snapshot.

instance_snapshot.progress

The progress of the snapshot.

This is populated only for disk snapshots, and is null for instance snapshots.

instance_snapshot.resource_type

The type of resource (usually InstanceSnapshot).

instance_snapshot.size_in_gb

The size in GB of the SSD.

instance_snapshot.state

The state the snapshot is in.

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

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

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