- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteSourceServerCommand
Deletes a single source server by ID.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MgnClient, DeleteSourceServerCommand } from "@aws-sdk/client-mgn"; // ES Modules import
// const { MgnClient, DeleteSourceServerCommand } = require("@aws-sdk/client-mgn"); // CommonJS import
const client = new MgnClient(config);
const input = { // DeleteSourceServerRequest
sourceServerID: "STRING_VALUE", // required
accountID: "STRING_VALUE",
};
const command = new DeleteSourceServerCommand(input);
const response = await client.send(command);
// {};
DeleteSourceServerCommand Input
See DeleteSourceServerCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
sourceServerIDRequired | string | undefined | Request to delete Source Server from service by Server ID. |
accountID | string | undefined | Request to delete Source Server from service by Account ID. |
DeleteSourceServerCommand Output
See DeleteSourceServerCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| ConflictException | client | The request could not be completed due to a conflict with the current state of the target resource. |
| ResourceNotFoundException | client | Resource not found exception. |
| UninitializedAccountException | client | Uninitialized account exception. |
| MgnServiceException | Base exception class for all service exceptions from Mgn service. |