DescribeStorageSystemResourceMetricsCommand

Suggest an Edit

Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.

Example Syntax

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

import { DataSyncClient, DescribeStorageSystemResourceMetricsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeStorageSystemResourceMetricsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeStorageSystemResourceMetricsRequest
  DiscoveryJobArn: "STRING_VALUE", // required
  ResourceType: "SVM" || "VOLUME" || "CLUSTER", // required
  ResourceId: "STRING_VALUE", // required
  StartTime: new Date("TIMESTAMP"),
  EndTime: new Date("TIMESTAMP"),
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new DescribeStorageSystemResourceMetricsCommand(input);
const response = await client.send(command);
// { // DescribeStorageSystemResourceMetricsResponse
//   Metrics: [ // Metrics
//     { // ResourceMetrics
//       Timestamp: new Date("TIMESTAMP"),
//       P95Metrics: { // P95Metrics
//         IOPS: { // IOPS
//           Read: Number("double"),
//           Write: Number("double"),
//           Other: Number("double"),
//           Total: Number("double"),
//         },
//         Throughput: { // Throughput
//           Read: Number("double"),
//           Write: Number("double"),
//           Other: Number("double"),
//           Total: Number("double"),
//         },
//         Latency: { // Latency
//           Read: Number("double"),
//           Write: Number("double"),
//           Other: Number("double"),
//         },
//       },
//       Capacity: { // Capacity
//         Used: Number("long"),
//         Provisioned: Number("long"),
//         LogicalUsed: Number("long"),
//         ClusterCloudStorageUsed: Number("long"),
//       },
//       ResourceId: "STRING_VALUE",
//       ResourceType: "SVM" || "VOLUME" || "CLUSTER",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeStorageSystemResourceMetricsCommand Input

See DescribeStorageSystemResourceMetricsCommandInput for more details

Parameter
Type
Description
DiscoveryJobArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.

ResourceId
Required
string | undefined

Specifies the universally unique identifier (UUID) of the storage system resource that you want information about.

ResourceType
Required
DiscoveryResourceType | undefined

Specifies the kind of storage system resource that you want information about.

EndTime
Date | undefined

Specifies a time within the total duration that the discovery job ran. To see information gathered during a certain time frame, use this parameter with StartTime.

MaxResults
number | undefined

Specifies how many results that 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.

StartTime
Date | undefined

Specifies a time within the total duration that the discovery job ran. To see information gathered during a certain time frame, use this parameter with EndTime.

DescribeStorageSystemResourceMetricsCommand Output

See DescribeStorageSystemResourceMetricsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Metrics
ResourceMetrics[] | undefined

The details that your discovery job collected about your storage system resource.

NextToken
string | undefined

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

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.