Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . lightsail ]

get-disk-snapshots

Description

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

If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-disk-snapshots
[--page-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--page-token (string)

A token used for advancing to the next page of results from your GetDiskSnapshots request.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

diskSnapshots -> (list)

An array of objects containing information about all block storage disk snapshots.

(structure)

Describes a block storage 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 ).

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 you are creating the disk snapshot.

fromDiskArn -> (string)

The Amazon Resource Name (ARN) of the source disk from which you are creating the disk snapshot.

nextPageToken -> (string)

A token used for advancing to the next page of results from your GetDiskSnapshots request.