GetDiskCommand

Suggest an Edit

Returns information about a specific block storage disk.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LightsailClient, GetDiskCommand } from "@aws-sdk/client-lightsail"; // ES Modules import
// const { LightsailClient, GetDiskCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import
const client = new LightsailClient(config);
const input = { // GetDiskRequest
  diskName: "STRING_VALUE", // required
};
const command = new GetDiskCommand(input);
const response = await client.send(command);
// { // GetDiskResult
//   disk: { // Disk
//     name: "STRING_VALUE",
//     arn: "STRING_VALUE",
//     supportCode: "STRING_VALUE",
//     createdAt: new Date("TIMESTAMP"),
//     location: { // ResourceLocation
//       availabilityZone: "STRING_VALUE",
//       regionName: "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "eu-central-1" || "ca-central-1" || "ap-south-1" || "ap-southeast-1" || "ap-southeast-2" || "ap-northeast-1" || "ap-northeast-2" || "eu-north-1",
//     },
//     resourceType: "ContainerService" || "Instance" || "StaticIp" || "KeyPair" || "InstanceSnapshot" || "Domain" || "PeeredVpc" || "LoadBalancer" || "LoadBalancerTlsCertificate" || "Disk" || "DiskSnapshot" || "RelationalDatabase" || "RelationalDatabaseSnapshot" || "ExportSnapshotRecord" || "CloudFormationStackRecord" || "Alarm" || "ContactMethod" || "Distribution" || "Certificate" || "Bucket",
//     tags: [ // TagList
//       { // Tag
//         key: "STRING_VALUE",
//         value: "STRING_VALUE",
//       },
//     ],
//     addOns: [ // AddOnList
//       { // AddOn
//         name: "STRING_VALUE",
//         status: "STRING_VALUE",
//         snapshotTimeOfDay: "STRING_VALUE",
//         nextSnapshotTimeOfDay: "STRING_VALUE",
//         threshold: "STRING_VALUE",
//         duration: "STRING_VALUE",
//       },
//     ],
//     sizeInGb: Number("int"),
//     isSystemDisk: true || false,
//     iops: Number("int"),
//     path: "STRING_VALUE",
//     state: "pending" || "error" || "available" || "in-use" || "unknown",
//     attachedTo: "STRING_VALUE",
//     isAttached: true || false,
//     attachmentState: "STRING_VALUE",
//     gbInUse: Number("int"),
//     autoMountStatus: "Failed" || "Pending" || "Mounted" || "NotMounted",
//   },
// };

GetDiskCommand Input

See GetDiskCommandInput for more details

Parameter
Type
Description
diskName
Required
string | undefined

The name of the disk (my-disk).

GetDiskCommand Output

See GetDiskCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
disk
Disk | undefined

An object containing information about the disk.

Throws

Name
Fault
Details
AccessDeniedException
client

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

AccountSetupInProgressException
client

Lightsail throws this exception when an account is still in the setup in progress state.

InvalidInputException
client

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

NotFoundException
client

Lightsail throws this exception when it cannot find a resource.

OperationFailureException
client

Lightsail throws this exception when an operation fails to execute.

ServiceException
server

A general service exception.

UnauthenticatedException
client

Lightsail throws this exception when the user has not been authenticated.

LightsailServiceException
Base exception class for all service exceptions from Lightsail service.