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

************************
describe_fhir_import_job
************************



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

  

  Get the import job properties to learn more about the job or job progress.

  

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


  **Request Syntax**
  ::

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

    The data store identifier.

    

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

    The import job identifier.

    

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

    
    ::

      {
          'ImportJobProperties': {
              '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',
              'InputDataConfig': {
                  'S3Uri': 'string'
              },
              'JobOutputDataConfig': {
                  'S3Configuration': {
                      'S3Uri': 'string',
                      'KmsKeyId': 'string'
                  }
              },
              'JobProgressReport': {
                  'TotalNumberOfScannedFiles': 123,
                  'TotalSizeOfScannedFilesInMB': 123.0,
                  'TotalNumberOfImportedFiles': 123,
                  'TotalNumberOfResourcesScanned': 123,
                  'TotalNumberOfResourcesImported': 123,
                  'TotalNumberOfResourcesWithCustomerError': 123,
                  'TotalNumberOfFilesReadWithCustomerError': 123,
                  'Throughput': 123.0
              },
              'DataAccessRoleArn': 'string',
              'Message': 'string',
              'ValidationLevel': 'strict'|'structure-only'|'minimal'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ImportJobProperties** *(dict) --* 

        The import job properties.

        
        

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

          The import job identifier.

          
        

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

          The import job name.

          
        

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

          The import job status.

          
        

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

          The time the import job was submitted for processing.

          
        

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

          The time the import job was completed.

          
        

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

          The data store identifier.

          
        

        - **InputDataConfig** *(dict) --* 

          The input data configuration supplied when the import job was created.

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


        
          

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

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

            
      
        

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

              
        
      
        

        - **JobProgressReport** *(dict) --* 

          Displays the progress of the import job, including total resources scanned, total resources imported, and total size of data imported.

          
          

          - **TotalNumberOfScannedFiles** *(integer) --* 

            The number of files scanned from the S3 input bucket.

            
          

          - **TotalSizeOfScannedFilesInMB** *(float) --* 

            The size (in MB) of files scanned from the S3 input bucket.

            
          

          - **TotalNumberOfImportedFiles** *(integer) --* 

            The number of files imported.

            
          

          - **TotalNumberOfResourcesScanned** *(integer) --* 

            The number of resources scanned from the S3 input bucket.

            
          

          - **TotalNumberOfResourcesImported** *(integer) --* 

            The number of resources imported.

            
          

          - **TotalNumberOfResourcesWithCustomerError** *(integer) --* 

            The number of resources that failed due to customer error.

            
          

          - **TotalNumberOfFilesReadWithCustomerError** *(integer) --* 

            The number of files that failed to be read from the S3 input bucket due to customer error.

            
          

          - **Throughput** *(float) --* 

            The transaction rate the import job is processed at.

            
      
        

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

          The Amazon Resource Name (ARN) that grants AWS HealthLake access to the input data.

          
        

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

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

          
        

        - **ValidationLevel** *(string) --* 

          The validation level of the import 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`

  