get-disk-snapshot¶

Description¶

Returns information about a specific block storage disk snapshot.

Synopsis¶

  get-disk-snapshot
--disk-snapshot-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--disk-snapshot-name (string)

The name of the disk snapshot (e.g., my-disk-snapshot ).

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To get information about a disk snapshot

The following get-disk-snapshot example displays details about the disk snapshot Disk-1-1566839161.

aws lightsail get-disk-snapshot \
    --disk-snapshot-name Disk-1-1566839161

Output:

{
    "diskSnapshot": {
        "name": "Disk-1-1566839161",
        "arn": "arn:aws:lightsail:us-west-2:111122223333:DiskSnapshot/e2d0fa53-8ee0-41a0-8e56-0EXAMPLE1051",
        "supportCode": "6EXAMPLE3362/snap-0EXAMPLE06100d09",
        "createdAt": 1566839163.749,
        "location": {
            "availabilityZone": "all",
            "regionName": "us-west-2"
        },
        "resourceType": "DiskSnapshot",
        "tags": [],
        "sizeInGb": 8,
        "state": "completed",
        "progress": "100%",
        "fromDiskName": "Disk-1",
        "fromDiskArn": "arn:aws:lightsail:us-west-2:111122223333:Disk/c21cfb0a-07f2-44ae-9a23-bEXAMPLE8096",
        "isFromAutoSnapshot": false
    }
}

For more information, see title in the guide.

Output¶

diskSnapshot -> (structure)

An object containing information about the disk snapshot.

name -> (string)

The name of the disk snapshot (e.g., my-disk-snapshot ).

arn -> (string)

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

supportCode -> (string)

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.

createdAt -> (timestamp)

The date when the disk snapshot was created.

location -> (structure)

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

availabilityZone -> (string)

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

regionName -> (string)

The AWS Region name.

resourceType -> (string)

The Lightsail resource type (e.g., DiskSnapshot ).

tags -> (list)

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

(structure)

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide .

key -> (string)

The key of the tag.

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

value -> (string)

The value of the tag.

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

sizeInGb -> (integer)

The size of the disk in GB.

state -> (string)

The status of the disk snapshot operation.

progress -> (string)

The progress of the disk snapshot operation.

fromDiskName -> (string)

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

fromDiskArn -> (string)

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

fromInstanceName -> (string)

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

fromInstanceArn -> (string)

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

isFromAutoSnapshot -> (boolean)

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

Table of Contents

Feedback

User Guide