:doc:`WorkMail <../../workmail>` / Client / describe_mailbox_export_job

***************************
describe_mailbox_export_job
***************************



.. py:method:: WorkMail.Client.describe_mailbox_export_job(**kwargs)

  

  Describes the current status of a mailbox export job.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeMailboxExportJob>`_  


  **Request Syntax**
  ::

    response = client.describe_mailbox_export_job(
        JobId='string',
        OrganizationId='string'
    )
    
  :type JobId: string
  :param JobId: **[REQUIRED]** 

    The mailbox export job ID.

    

  
  :type OrganizationId: string
  :param OrganizationId: **[REQUIRED]** 

    The organization ID.

    

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

    
    ::

      {
          'EntityId': 'string',
          'Description': 'string',
          'RoleArn': 'string',
          'KmsKeyArn': 'string',
          'S3BucketName': 'string',
          'S3Prefix': 'string',
          'S3Path': 'string',
          'EstimatedProgress': 123,
          'State': 'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED',
          'ErrorInfo': 'string',
          'StartTime': datetime(2015, 1, 1),
          'EndTime': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **EntityId** *(string) --* 

        The identifier of the user or resource associated with the mailbox.

        
      

      - **Description** *(string) --* 

        The mailbox export job description.

        
      

      - **RoleArn** *(string) --* 

        The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.

        
      

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

        The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

        
      

      - **S3BucketName** *(string) --* 

        The name of the S3 bucket.

        
      

      - **S3Prefix** *(string) --* 

        The S3 bucket prefix.

        
      

      - **S3Path** *(string) --* 

        The path to the S3 bucket and file that the mailbox export job is exporting to.

        
      

      - **EstimatedProgress** *(integer) --* 

        The estimated progress of the mailbox export job, in percentage points.

        
      

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

        The state of the mailbox export job.

        
      

      - **ErrorInfo** *(string) --* 

        Error information for failed mailbox export jobs.

        
      

      - **StartTime** *(datetime) --* 

        The mailbox export job start timestamp.

        
      

      - **EndTime** *(datetime) --* 

        The mailbox export job end timestamp.

        
  
  **Exceptions**
  
  *   :py:class:`WorkMail.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationNotFoundException`

  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationStateException`

  
  *   :py:class:`WorkMail.Client.exceptions.EntityNotFoundException`

  