:doc:`HealthLake <../../healthlake>` / Client / describe_fhir_export_job

************************
describe_fhir_export_job
************************



.. py:method:: HealthLake.Client.describe_fhir_export_job(**kwargs)

  

  Get FHIR export job properties.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRExportJob>`_  


  **Request Syntax**
  ::

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

    The data store identifier from which FHIR data is being exported from.

    

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

    The export job identifier.

    

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

    
    ::

      {
          'ExportJobProperties': {
              'JobId': 'string',
              'JobName': 'string',
              'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
              'SubmitTime': datetime(2015, 1, 1),
              'EndTime': datetime(2015, 1, 1),
              'DatastoreId': 'string',
              'OutputDataConfig': {
                  'S3Configuration': {
                      'S3Uri': 'string',
                      'KmsKeyId': 'string'
                  }
              },
              'DataAccessRoleArn': 'string',
              'Message': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ExportJobProperties** *(dict) --* 

        The export job properties.

        
        

        - **JobId** *(string) --* 

          The export job identifier.

          
        

        - **JobName** *(string) --* 

          The export job name.

          
        

        - **JobStatus** *(string) --* 

          The export job status.

          
        

        - **SubmitTime** *(datetime) --* 

          The time the export job was initiated.

          
        

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

          The time the export job completed.

          
        

        - **DatastoreId** *(string) --* 

          The data store identifier from which files are being exported.

          
        

        - **OutputDataConfig** *(dict) --* 

          The output data configuration supplied when the export job was created.

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


        
          

          - **S3Configuration** *(dict) --* 

            The output data configuration supplied when the export job was created.

            
            

            - **S3Uri** *(string) --* 

              The ``S3Uri`` is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.

              
            

            - **KmsKeyId** *(string) --* 

              The Key Management Service (KMS) key ID used to access the S3 bucket.

              
        
      
        

        - **DataAccessRoleArn** *(string) --* 

          The Amazon Resource Name (ARN) used during the initiation of the export job.

          
        

        - **Message** *(string) --* 

          An explanation of any errors that might have occurred during the export job.

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

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

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

  
  *   :py:class:`HealthLake.Client.exceptions.InternalServerException`

  