ListStorageSystemsCommand

Suggest an Edit

Lists the on-premises storage systems that you're using with DataSync Discovery.

Example Syntax

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

import { DataSyncClient, ListStorageSystemsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, ListStorageSystemsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // ListStorageSystemsRequest
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListStorageSystemsCommand(input);
const response = await client.send(command);
// { // ListStorageSystemsResponse
//   StorageSystems: [ // StorageSystemList
//     { // StorageSystemListEntry
//       StorageSystemArn: "STRING_VALUE",
//       Name: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListStorageSystemsCommand Input

See ListStorageSystemsCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

Specifies how many results you want in the response.

NextToken
string | undefined

Specifies an opaque string that indicates the position to begin the next list of results in the response.

ListStorageSystemsCommand Output

See ListStorageSystemsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

The opaque string that indicates the position to begin the next list of results in the response.

StorageSystems
StorageSystemListEntry[] | undefined

The Amazon Resource Names ARNs) of the on-premises storage systems that you're using with DataSync Discovery.

Throws

Name
Fault
Details
InternalException
server

This exception is thrown when an error occurs in the DataSync service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

DataSyncServiceException
Base exception class for all service exceptions from DataSync service.