Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

ListLocalDisksCommand

Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.

The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).

Example Syntax

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

import { StorageGatewayClient, ListLocalDisksCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
// const { StorageGatewayClient, ListLocalDisksCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
const client = new StorageGatewayClient(config);
const input = { // ListLocalDisksInput
  GatewayARN: "STRING_VALUE", // required
};
const command = new ListLocalDisksCommand(input);
const response = await client.send(command);
// { // ListLocalDisksOutput
//   GatewayARN: "STRING_VALUE",
//   Disks: [ // Disks
//     { // Disk
//       DiskId: "STRING_VALUE",
//       DiskPath: "STRING_VALUE",
//       DiskNode: "STRING_VALUE",
//       DiskStatus: "STRING_VALUE",
//       DiskSizeInBytes: Number("long"),
//       DiskAllocationType: "STRING_VALUE",
//       DiskAllocationResource: "STRING_VALUE",
//       DiskAttributeList: [ // DiskAttributeList
//         "STRING_VALUE",
//       ],
//     },
//   ],
// };

Example Usage

There was an error loading the code editor. Retry