Menu
Amazon Lightsail
REST API Reference (API Version 2016-11-28)

InstanceSnapshot

Describes the snapshot of the virtual private server, or instance.

Contents

arn

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

Type: String

Pattern: .*\S.*

Required: No

createdAt

The timestamp when the snapshot was created (e.g., 1479907467.024).

Type: Timestamp

Required: No

fromAttachedDisks

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

Type: Array of Disk objects

Required: No

fromBlueprintId

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

Type: String

Required: No

fromBundleId

The bundle ID from which you created the snapshot (e.g., micro_1_0).

Type: String

Required: No

fromInstanceArn

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

Type: String

Pattern: .*\S.*

Required: No

fromInstanceName

The instance from which the snapshot was created.

Type: String

Pattern: \w[\w\-]*\w

Required: No

location

The region name and availability zone where you created the snapshot.

Type: ResourceLocation object

Required: No

name

The name of the snapshot.

Type: String

Pattern: \w[\w\-]*\w

Required: No

progress

The progress of the snapshot.

Type: String

Required: No

resourceType

The type of resource (usually InstanceSnapshot).

Type: String

Valid Values: Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot

Required: No

sizeInGb

The size in GB of the SSD.

Type: Integer

Required: No

state

The state the snapshot is in.

Type: String

Valid Values: pending | error | available

Required: No

supportCode

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.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: