Table Of Contents


User Guide

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

[ aws . lightsail ]



Returns information about a specific block storage disk.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--disk-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--disk-name (string)

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

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


disk -> (structure)

An object containing information about the disk.

name -> (string)

The unique name of the disk.

arn -> (string)

The Amazon Resource Name (ARN) of the disk.

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

location -> (structure)

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

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., Disk ).

sizeInGb -> (integer)

The size of the disk in GB.

isSystemDisk -> (boolean)

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

iops -> (integer)

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

path -> (string)

The disk path.

state -> (string)

Describes the status of the disk.

attachedTo -> (string)

The resources to which the disk is attached.

isAttached -> (boolean)

A Boolean value indicating whether the disk is attached.

attachmentState -> (string)

(Deprecated) The attachment state of the disk.


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.

gbInUse -> (integer)

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


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