UpdateStorageSystemCommand

Modifies some configurations of an on-premises storage system resource 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, UpdateStorageSystemCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, UpdateStorageSystemCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // UpdateStorageSystemRequest
  StorageSystemArn: "STRING_VALUE", // required
  ServerConfiguration: { // DiscoveryServerConfiguration
    ServerHostname: "STRING_VALUE", // required
    ServerPort: Number("int"),
  },
  AgentArns: [ // DiscoveryAgentArnList
    "STRING_VALUE",
  ],
  Name: "STRING_VALUE",
  CloudWatchLogGroupArn: "STRING_VALUE",
  Credentials: { // Credentials
    Username: "STRING_VALUE", // required
    Password: "STRING_VALUE", // required
  },
};
const command = new UpdateStorageSystemCommand(input);
const response = await client.send(command);
// {};

UpdateStorageSystemCommand Input

See UpdateStorageSystemCommandInput for more details

Parameter
Type
Description
StorageSystemArn
Required
string | undefined

Specifies the ARN of the on-premises storage system that you want reconfigure.

AgentArns
string[] | undefined

Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads your on-premises storage system. You can only specify one ARN.

CloudWatchLogGroupArn
string | undefined

Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.

Credentials
Credentials | undefined

Specifies the user name and password for accessing your on-premises storage system's management interface.

Name
string | undefined

Specifies a familiar name for your on-premises storage system.

ServerConfiguration
DiscoveryServerConfiguration | undefined

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

UpdateStorageSystemCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

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.