Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lightsail ]

get-auto-snapshots

Description

Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-auto-snapshots
--resource-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--resource-name (string)

The name of the source instance or disk from which to get automatic snapshot information.

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

Examples

To get the available automatic snapshots for an instance

The following get-auto-snapshots example returns the available automatic snapshots for instance WordPress-1.

aws lightsail get-auto-snapshots \
    --resource-name WordPress-1

Output:

{
    "resourceName": "WordPress-1",
    "resourceType": "Instance",
    "autoSnapshots": [
        {
            "date": "2019-10-14",
            "createdAt": 1571033872.0,
            "status": "Success",
            "fromAttachedDisks": []
        },
        {
            "date": "2019-10-13",
            "createdAt": 1570947473.0,
            "status": "Success",
            "fromAttachedDisks": []
        },
        {
            "date": "2019-10-12",
            "createdAt": 1570861072.0,
            "status": "Success",
            "fromAttachedDisks": []
        },
        {
            "date": "2019-10-11",
            "createdAt": 1570774672.0,
            "status": "Success",
            "fromAttachedDisks": []
        }
    ]
}

For more information, see Keeping automatic snapshots of instances or disks in Amazon Lightsail in the Lightsail Dev Guide.

Output

resourceName -> (string)

The name of the source instance or disk for the automatic snapshots.

resourceType -> (string)

The resource type (e.g., Instance or Disk ).

autoSnapshots -> (list)

An array of objects that describe the automatic snapshots that are available for the specified source instance or disk.

(structure)

Describes an automatic snapshot.

date -> (string)

The date of the automatic snapshot in YYYY-MM-DD format.

createdAt -> (timestamp)

The timestamp when the automatic snapshot was created.

status -> (string)

The status of the automatic snapshot.

fromAttachedDisks -> (list)

An array of objects that describe the block storage disks attached to the instance when the automatic snapshot was created.

(structure)

Describes a block storage disk that is attached to an instance, and is included in an automatic snapshot.

path -> (string)

The path of the disk (e.g., /dev/xvdf ).

sizeInGb -> (integer)

The size of the disk in GB.