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

******************
get_archive_export
******************



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

  

  Retrieves the details and current status of a specific email archive export job.

  

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


  **Request Syntax**
  ::

    response = client.get_archive_export(
        ExportId='string'
    )
    
  :type ExportId: string
  :param ExportId: **[REQUIRED]** 

    The identifier of the export job to get details for.

    

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

    
    ::

      {
          'ArchiveId': 'string',
          'Filters': {
              'Include': [
                  {
                      'StringExpression': {
                          'Evaluate': {
                              'Attribute': 'TO'|'FROM'|'CC'|'SUBJECT'|'ENVELOPE_TO'|'ENVELOPE_FROM'
                          },
                          'Operator': 'CONTAINS',
                          'Values': [
                              'string',
                          ]
                      },
                      'BooleanExpression': {
                          'Evaluate': {
                              'Attribute': 'HAS_ATTACHMENTS'
                          },
                          'Operator': 'IS_TRUE'|'IS_FALSE'
                      }
                  },
              ],
              'Unless': [
                  {
                      'StringExpression': {
                          'Evaluate': {
                              'Attribute': 'TO'|'FROM'|'CC'|'SUBJECT'|'ENVELOPE_TO'|'ENVELOPE_FROM'
                          },
                          'Operator': 'CONTAINS',
                          'Values': [
                              'string',
                          ]
                      },
                      'BooleanExpression': {
                          'Evaluate': {
                              'Attribute': 'HAS_ATTACHMENTS'
                          },
                          'Operator': 'IS_TRUE'|'IS_FALSE'
                      }
                  },
              ]
          },
          'FromTimestamp': datetime(2015, 1, 1),
          'ToTimestamp': datetime(2015, 1, 1),
          'MaxResults': 123,
          'ExportDestinationConfiguration': {
              'S3': {
                  'S3Location': 'string'
              }
          },
          'Status': {
              'SubmissionTimestamp': datetime(2015, 1, 1),
              'CompletionTimestamp': datetime(2015, 1, 1),
              'State': 'QUEUED'|'PREPROCESSING'|'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLED',
              'ErrorMessage': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The response containing details of the specified archive export job.

      
      

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

        The identifier of the archive the email export was performed from.

        
      

      - **Filters** *(dict) --* 

        The criteria used to filter emails included in the export.

        
        

        - **Include** *(list) --* 

          The filter conditions for emails to include.

          
          

          - *(dict) --* 

            A filter condition used to include or exclude emails when exporting from or searching an archive.

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``StringExpression``, ``BooleanExpression``.     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'}


          
            

            - **StringExpression** *(dict) --* 

              A string expression to evaluate against email attributes.

              
              

              - **Evaluate** *(dict) --* 

                The attribute of the email to evaluate.

                .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``Attribute``.     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'}


              
                

                - **Attribute** *(string) --* 

                  The name of the email attribute to evaluate.

                  
            
              

              - **Operator** *(string) --* 

                The operator to use when evaluating the string values.

                
              

              - **Values** *(list) --* 

                The list of string values to evaluate the email attribute against.

                
                

                - *(string) --* 
            
          
            

            - **BooleanExpression** *(dict) --* 

              A boolean expression to evaluate against email attributes.

              
              

              - **Evaluate** *(dict) --* 

                The email attribute value to evaluate.

                .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``Attribute``.     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'}


              
                

                - **Attribute** *(string) --* 

                  The name of the email attribute to evaluate.

                  
            
              

              - **Operator** *(string) --* 

                The boolean operator to use for evaluation.

                
          
        
      
        

        - **Unless** *(list) --* 

          The filter conditions for emails to exclude.

          
          

          - *(dict) --* 

            A filter condition used to include or exclude emails when exporting from or searching an archive.

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``StringExpression``, ``BooleanExpression``.     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'}


          
            

            - **StringExpression** *(dict) --* 

              A string expression to evaluate against email attributes.

              
              

              - **Evaluate** *(dict) --* 

                The attribute of the email to evaluate.

                .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``Attribute``.     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'}


              
                

                - **Attribute** *(string) --* 

                  The name of the email attribute to evaluate.

                  
            
              

              - **Operator** *(string) --* 

                The operator to use when evaluating the string values.

                
              

              - **Values** *(list) --* 

                The list of string values to evaluate the email attribute against.

                
                

                - *(string) --* 
            
          
            

            - **BooleanExpression** *(dict) --* 

              A boolean expression to evaluate against email attributes.

              
              

              - **Evaluate** *(dict) --* 

                The email attribute value to evaluate.

                .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``Attribute``.     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'}


              
                

                - **Attribute** *(string) --* 

                  The name of the email attribute to evaluate.

                  
            
              

              - **Operator** *(string) --* 

                The boolean operator to use for evaluation.

                
          
        
      
    
      

      - **FromTimestamp** *(datetime) --* 

        The start of the timestamp range the exported emails cover.

        
      

      - **ToTimestamp** *(datetime) --* 

        The end of the date range the exported emails cover.

        
      

      - **MaxResults** *(integer) --* 

        The maximum number of email items included in the export.

        
      

      - **ExportDestinationConfiguration** *(dict) --* 

        Where the exported emails are being delivered.

        .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``S3``.     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'}


      
        

        - **S3** *(dict) --* 

          Configuration for delivering to an Amazon S3 bucket.

          
          

          - **S3Location** *(string) --* 

            The S3 location to deliver the exported email data.

            
      
    
      

      - **Status** *(dict) --* 

        The current status of the export job.

        
        

        - **SubmissionTimestamp** *(datetime) --* 

          The timestamp of when the export job was submitted.

          
        

        - **CompletionTimestamp** *(datetime) --* 

          The timestamp of when the export job completed (if finished).

          
        

        - **State** *(string) --* 

          The current state of the export job.

          
        

        - **ErrorMessage** *(string) --* 

          An error message if the export job failed.

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

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

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

  