MailManager / Client / delete_archive

delete_archive#

MailManager.Client.delete_archive(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_archive(
    ArchiveId='string'
)
Parameters:

ArchiveId (string) –

[REQUIRED]

The identifier of the archive to delete.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    The response indicating if the archive deletion was successfully initiated.

    On success, returns an HTTP 200 status code. On failure, returns an error message.

Exceptions

  • MailManager.Client.exceptions.ValidationException

  • MailManager.Client.exceptions.AccessDeniedException

  • MailManager.Client.exceptions.ConflictException

  • MailManager.Client.exceptions.ThrottlingException