DescribeStorageSystemCommand

Suggest an Edit

Returns information about an on-premises storage system 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, DescribeStorageSystemCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeStorageSystemCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeStorageSystemRequest
  StorageSystemArn: "STRING_VALUE", // required
};
const command = new DescribeStorageSystemCommand(input);
const response = await client.send(command);
// { // DescribeStorageSystemResponse
//   StorageSystemArn: "STRING_VALUE",
//   ServerConfiguration: { // DiscoveryServerConfiguration
//     ServerHostname: "STRING_VALUE", // required
//     ServerPort: Number("int"),
//   },
//   SystemType: "NetAppONTAP",
//   AgentArns: [ // DiscoveryAgentArnList
//     "STRING_VALUE",
//   ],
//   Name: "STRING_VALUE",
//   ErrorMessage: "STRING_VALUE",
//   ConnectivityStatus: "PASS" || "FAIL" || "UNKNOWN",
//   CloudWatchLogGroupArn: "STRING_VALUE",
//   CreationTime: new Date("TIMESTAMP"),
//   SecretsManagerArn: "STRING_VALUE",
// };

DescribeStorageSystemCommand Input

See DescribeStorageSystemCommandInput for more details

Parameter
Type
Description
StorageSystemArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you're using with DataSync Discovery.

DescribeStorageSystemCommand Output

See DescribeStorageSystemCommandOutput for details

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

The ARN of the DataSync agent that connects to and reads from your on-premises storage system.

CloudWatchLogGroupArn
string | undefined

The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery job events.

ConnectivityStatus
StorageSystemConnectivityStatus | undefined

Indicates whether your DataSync agent can connect to your on-premises storage system.

CreationTime
Date | undefined

The time when you added the on-premises storage system to DataSync Discovery.

ErrorMessage
string | undefined

Describes the connectivity error that the DataSync agent is encountering with your on-premises storage system.

Name
string | undefined

The name that you gave your on-premises storage system when adding it to DataSync Discovery.

SecretsManagerArn
string | undefined

The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery stores these credentials in Secrets Manager .

ServerConfiguration
DiscoveryServerConfiguration | undefined

The server name and network port required to connect with your on-premises storage system's management interface.

StorageSystemArn
string | undefined

The ARN of the on-premises storage system that the discovery job looked at.

SystemType
DiscoverySystemType | undefined

The type of on-premises storage system.

DataSync Discovery currently only supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.

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.