MailManager / Client / get_archive

get_archive#

MailManager.Client.get_archive(**kwargs)#

Retrieves the full details and current state of a specified email archive.

See also: AWS API Documentation

Request Syntax

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

ArchiveId (string) –

[REQUIRED]

The identifier of the archive to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'ArchiveArn': 'string',
    'ArchiveId': 'string',
    'ArchiveName': 'string',
    'ArchiveState': 'ACTIVE'|'PENDING_DELETION',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'KmsKeyArn': 'string',
    'LastUpdatedTimestamp': datetime(2015, 1, 1),
    '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'
    }
}

Response Structure

  • (dict) –

    The response containing details of the requested archive.

    • ArchiveArn (string) –

      The Amazon Resource Name (ARN) of the archive.

    • ArchiveId (string) –

      The unique identifier of the archive.

    • ArchiveName (string) –

      The unique name assigned to the archive.

    • ArchiveState (string) –

      The current state of the archive:

      • ACTIVE – The archive is ready and available for use.

      • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

    • CreatedTimestamp (datetime) –

      The timestamp of when the archive was created.

    • KmsKeyArn (string) –

      The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.

    • LastUpdatedTimestamp (datetime) –

      The timestamp of when the archive was modified.

    • Retention (dict) –

      The retention period for emails in this archive.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: RetentionPeriod. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • RetentionPeriod (string) –

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

Exceptions

  • MailManager.Client.exceptions.ValidationException

  • MailManager.Client.exceptions.AccessDeniedException

  • MailManager.Client.exceptions.ResourceNotFoundException

  • MailManager.Client.exceptions.ThrottlingException