:doc:`MailManager <../../mailmanager>` / Client / get_archive

***********
get_archive
***********



.. py:method:: MailManager.Client.get_archive(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchive>`_  


  **Request Syntax**
  ::

    response = client.get_archive(
        ArchiveId='string'
    )
    
  :type ArchiveId: string
  :param ArchiveId: **[REQUIRED]** 

    The identifier of the archive to retrieve.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

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

    

    - *(dict) --* 

      The response containing details of the requested archive.

      
      

      - **ArchiveId** *(string) --* 

        The unique identifier of the archive.

        
      

      - **ArchiveName** *(string) --* 

        The unique name assigned to the archive.

        
      

      - **ArchiveArn** *(string) --* 

        The Amazon Resource Name (ARN) of 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.
        

        
      

      - **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.

          
    
      

      - **CreatedTimestamp** *(datetime) --* 

        The timestamp of when the archive was created.

        
      

      - **LastUpdatedTimestamp** *(datetime) --* 

        The timestamp of when the archive was modified.

        
      

      - **KmsKeyArn** *(string) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`MailManager.Client.exceptions.ValidationException`

  
  *   :py:class:`MailManager.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`MailManager.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`MailManager.Client.exceptions.ThrottlingException`

  