- 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.
DeleteArchiveCommand
Deletes the specified archive.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { CloudWatchEventsClient, DeleteArchiveCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import
// const { CloudWatchEventsClient, DeleteArchiveCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import
const client = new CloudWatchEventsClient(config);
const input = { // DeleteArchiveRequest
ArchiveName: "STRING_VALUE", // required
};
const command = new DeleteArchiveCommand(input);
const response = await client.send(command);
// {};
DeleteArchiveCommand Input
See DeleteArchiveCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ArchiveNameRequired | string | undefined | The name of the archive to delete. |
DeleteArchiveCommand Output
See DeleteArchiveCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| ConcurrentModificationException | client | There is concurrent modification on a rule, target, archive, or replay. |
| InternalException | server | This exception occurs due to unexpected causes. |
| ResourceNotFoundException | client | An entity that you specified does not exist. |
| CloudWatchEventsServiceException | Base exception class for all service exceptions from CloudWatchEvents service. |