MailManager / Client / update_archive

update_archive#

MailManager.Client.update_archive(**kwargs)#

Updates the attributes of an existing email archive.

See also: AWS API Documentation

Request Syntax

response = client.update_archive(
    ArchiveId='string',
    ArchiveName='string',
    Retention={
        'RetentionPeriod': 'THREE_MONTHS'|'SIX_MONTHS'|'NINE_MONTHS'|'ONE_YEAR'|'EIGHTEEN_MONTHS'|'TWO_YEARS'|'THIRTY_MONTHS'|'THREE_YEARS'|'FOUR_YEARS'|'FIVE_YEARS'|'SIX_YEARS'|'SEVEN_YEARS'|'EIGHT_YEARS'|'NINE_YEARS'|'TEN_YEARS'|'PERMANENT'
    }
)
Parameters:

  • ArchiveId (string) –

    [REQUIRED]

    The identifier of the archive to update.

  • ArchiveName (string) – A new, unique name for the archive.

  • Retention (dict) –

    A new retention period for emails in the archive.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: RetentionPeriod.

    • RetentionPeriod (string) –

      The enum value sets the period for retaining emails in an archive.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    The response indicating if the archive update succeeded or failed.

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

Exceptions