- 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.
DeleteWaveCommand
Delete wave.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MgnClient, DeleteWaveCommand } from "@aws-sdk/client-mgn"; // ES Modules import
// const { MgnClient, DeleteWaveCommand } = require("@aws-sdk/client-mgn"); // CommonJS import
const client = new MgnClient(config);
const input = { // DeleteWaveRequest
waveID: "STRING_VALUE", // required
accountID: "STRING_VALUE",
};
const command = new DeleteWaveCommand(input);
const response = await client.send(command);
// {};
DeleteWaveCommand Input
See DeleteWaveCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
waveID Required | string | undefined | Wave ID. |
accountID | string | undefined | Account ID. |
DeleteWaveCommand Output
See DeleteWaveCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | 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. |