DescribeStorageSystemResourcesCommand

Suggest an Edit

Returns information that DataSync Discovery collects about resources in your on-premises storage system.

Example Syntax

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

import { DataSyncClient, DescribeStorageSystemResourcesCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeStorageSystemResourcesCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeStorageSystemResourcesRequest
  DiscoveryJobArn: "STRING_VALUE", // required
  ResourceType: "SVM" || "VOLUME" || "CLUSTER", // required
  ResourceIds: [ // ResourceIds
    "STRING_VALUE",
  ],
  Filter: { // ResourceFilters
    "<keys>": [ // FilterMembers
      "STRING_VALUE",
    ],
  },
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new DescribeStorageSystemResourcesCommand(input);
const response = await client.send(command);
// { // DescribeStorageSystemResourcesResponse
//   ResourceDetails: { // ResourceDetails
//     NetAppONTAPSVMs: [ // NetAppONTAPSVMs
//       { // NetAppONTAPSVM
//         ClusterUuid: "STRING_VALUE",
//         ResourceId: "STRING_VALUE",
//         SvmName: "STRING_VALUE",
//         CifsShareCount: Number("long"),
//         EnabledProtocols: [ // EnabledProtocols
//           "STRING_VALUE",
//         ],
//         TotalCapacityUsed: Number("long"),
//         TotalCapacityProvisioned: Number("long"),
//         TotalLogicalCapacityUsed: Number("long"),
//         MaxP95Performance: { // MaxP95Performance
//           IopsRead: Number("double"),
//           IopsWrite: Number("double"),
//           IopsOther: Number("double"),
//           IopsTotal: Number("double"),
//           ThroughputRead: Number("double"),
//           ThroughputWrite: Number("double"),
//           ThroughputOther: Number("double"),
//           ThroughputTotal: Number("double"),
//           LatencyRead: Number("double"),
//           LatencyWrite: Number("double"),
//           LatencyOther: Number("double"),
//         },
//         Recommendations: [ // Recommendations
//           { // Recommendation
//             StorageType: "STRING_VALUE",
//             StorageConfiguration: { // RecommendationsConfigMap
//               "<keys>": "STRING_VALUE",
//             },
//             EstimatedMonthlyStorageCost: "STRING_VALUE",
//           },
//         ],
//         NfsExportedVolumes: Number("long"),
//         RecommendationStatus: "NONE" || "IN_PROGRESS" || "COMPLETED" || "FAILED",
//         TotalSnapshotCapacityUsed: Number("long"),
//         LunCount: Number("long"),
//       },
//     ],
//     NetAppONTAPVolumes: [ // NetAppONTAPVolumes
//       { // NetAppONTAPVolume
//         VolumeName: "STRING_VALUE",
//         ResourceId: "STRING_VALUE",
//         CifsShareCount: Number("long"),
//         SecurityStyle: "STRING_VALUE",
//         SvmUuid: "STRING_VALUE",
//         SvmName: "STRING_VALUE",
//         CapacityUsed: Number("long"),
//         CapacityProvisioned: Number("long"),
//         LogicalCapacityUsed: Number("long"),
//         NfsExported: true || false,
//         SnapshotCapacityUsed: Number("long"),
//         MaxP95Performance: {
//           IopsRead: Number("double"),
//           IopsWrite: Number("double"),
//           IopsOther: Number("double"),
//           IopsTotal: Number("double"),
//           ThroughputRead: Number("double"),
//           ThroughputWrite: Number("double"),
//           ThroughputOther: Number("double"),
//           ThroughputTotal: Number("double"),
//           LatencyRead: Number("double"),
//           LatencyWrite: Number("double"),
//           LatencyOther: Number("double"),
//         },
//         Recommendations: [
//           {
//             StorageType: "STRING_VALUE",
//             StorageConfiguration: {
//               "<keys>": "STRING_VALUE",
//             },
//             EstimatedMonthlyStorageCost: "STRING_VALUE",
//           },
//         ],
//         RecommendationStatus: "NONE" || "IN_PROGRESS" || "COMPLETED" || "FAILED",
//         LunCount: Number("long"),
//       },
//     ],
//     NetAppONTAPClusters: [ // NetAppONTAPClusters
//       { // NetAppONTAPCluster
//         CifsShareCount: Number("long"),
//         NfsExportedVolumes: Number("long"),
//         ResourceId: "STRING_VALUE",
//         ClusterName: "STRING_VALUE",
//         MaxP95Performance: {
//           IopsRead: Number("double"),
//           IopsWrite: Number("double"),
//           IopsOther: Number("double"),
//           IopsTotal: Number("double"),
//           ThroughputRead: Number("double"),
//           ThroughputWrite: Number("double"),
//           ThroughputOther: Number("double"),
//           ThroughputTotal: Number("double"),
//           LatencyRead: Number("double"),
//           LatencyWrite: Number("double"),
//           LatencyOther: Number("double"),
//         },
//         ClusterBlockStorageSize: Number("long"),
//         ClusterBlockStorageUsed: Number("long"),
//         ClusterBlockStorageLogicalUsed: Number("long"),
//         Recommendations: [
//           {
//             StorageType: "STRING_VALUE",
//             StorageConfiguration: {
//               "<keys>": "STRING_VALUE",
//             },
//             EstimatedMonthlyStorageCost: "STRING_VALUE",
//           },
//         ],
//         RecommendationStatus: "NONE" || "IN_PROGRESS" || "COMPLETED" || "FAILED",
//         LunCount: Number("long"),
//         ClusterCloudStorageUsed: Number("long"),
//       },
//     ],
//   },
//   NextToken: "STRING_VALUE",
// };

DescribeStorageSystemResourcesCommand Input

See DescribeStorageSystemResourcesCommandInput for more details

Parameter
Type
Description
DiscoveryJobArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system.

ResourceType
Required
DiscoveryResourceType | undefined

Specifies what kind of storage system resources that you want information about.

Filter
Partial<Record<DiscoveryResourceFilter, string[]> | undefined

Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).

MaxResults
number | undefined

Specifies the maximum number of storage system resources that you want to list in a response.

NextToken
string | undefined

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

ResourceIds
string[] | undefined

Specifies the universally unique identifiers (UUIDs) of the storage system resources that you want information about. You can't use this parameter in combination with the Filter parameter.

DescribeStorageSystemResourcesCommand Output

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

ResourceDetails
ResourceDetails | undefined

The information collected about your storage system's resources. A response can also include Amazon Web Services storage service recommendations.

For more information, see storage resource information  collected by and recommendations  provided by 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.