DeleteArchiveCommand

Suggest an Edit

Initiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible (search, export, download). The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period.

Example Syntax

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

import { MailManagerClient, DeleteArchiveCommand } from "@aws-sdk/client-mailmanager"; // ES Modules import
// const { MailManagerClient, DeleteArchiveCommand } = require("@aws-sdk/client-mailmanager"); // CommonJS import
const client = new MailManagerClient(config);
const input = { // DeleteArchiveRequest
  ArchiveId: "STRING_VALUE", // required
};
const command = new DeleteArchiveCommand(input);
const response = await client.send(command);
// {};

DeleteArchiveCommand Input

See DeleteArchiveCommandInput for more details

Parameter
Type
Description
ArchiveId
Required
string | undefined

The identifier of the archive to delete.

DeleteArchiveCommand Output

See DeleteArchiveCommandOutput for details

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

Throws

Name
Fault
Details
AccessDeniedException
client

Occurs when a user is denied access to a specific resource or action.

ConflictException
client

The request configuration has conflicts. For details, see the accompanying error message.

ThrottlingException
client

Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

ValidationException
client

The request validation has failed. For details, see the accompanying error message.

MailManagerServiceException
Base exception class for all service exceptions from MailManager service.