RemoveStorageSystemCommand

Suggest an Edit

Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.

Example Syntax

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

import { DataSyncClient, RemoveStorageSystemCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, RemoveStorageSystemCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // RemoveStorageSystemRequest
  StorageSystemArn: "STRING_VALUE", // required
};
const command = new RemoveStorageSystemCommand(input);
const response = await client.send(command);
// {};

RemoveStorageSystemCommand Input

See RemoveStorageSystemCommandInput for more details

Parameter
Type
Description
StorageSystemArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of the storage system that you want to permanently remove from DataSync Discovery.

RemoveStorageSystemCommand Output

See RemoveStorageSystemCommandOutput for details

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.