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

Disk

Describes a system disk or an block storage disk.

Contents

arn

The Amazon Resource Name (ARN) of the disk.

Type: String

Pattern: .*\S.*

Required: No

attachedTo

The resources to which the disk is attached.

Type: String

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

Required: No

attachmentState

(Deprecated) The attachment state of the disk.

Note

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.

Type: String

Required: No

createdAt

The date when the disk was created.

Type: Timestamp

Required: No

gbInUse

(Deprecated) The number of GB in use by the disk.

Note

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

Type: Integer

Required: No

iops

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

Type: Integer

Required: No

isAttached

A Boolean value indicating whether the disk is attached.

Type: Boolean

Required: No

isSystemDisk

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

Type: Boolean

Required: No

location

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

Type: ResourceLocation object

Required: No

name

The unique name of the disk.

Type: String

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

Required: No

path

The disk path.

Type: String

Required: No

resourceType

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

Type: String

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

Required: No

sizeInGb

The size of the disk in GB.

Type: Integer

Required: No

state

Describes the status of the disk.

Type: String

Valid Values: pending | error | available | in-use | unknown

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: