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

*********************
list_fhir_export_jobs
*********************



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

  

  Lists all FHIR export jobs associated with an account and their statuses.

  

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


  **Request Syntax**
  ::

    response = client.list_fhir_export_jobs(
        DatastoreId='string',
        NextToken='string',
        MaxResults=123,
        JobName='string',
        JobStatus='SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
        SubmittedBefore=datetime(2015, 1, 1),
        SubmittedAfter=datetime(2015, 1, 1)
    )
    
  :type DatastoreId: string
  :param DatastoreId: **[REQUIRED]** 

    Limits the response to the export job with the specified data store ID.

    

  
  :type NextToken: string
  :param NextToken: 

    A pagination token used to identify the next page of results to return.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    Limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.

    

  
  :type JobName: string
  :param JobName: 

    Limits the response to the export job with the specified job name.

    

  
  :type JobStatus: string
  :param JobStatus: 

    Limits the response to export jobs with the specified job status.

    

  
  :type SubmittedBefore: datetime
  :param SubmittedBefore: 

    Limits the response to FHIR export jobs submitted before a user- specified date.

    

  
  :type SubmittedAfter: datetime
  :param SubmittedAfter: 

    Limits the response to FHIR export jobs submitted after a user-specified date.

    

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

    
    ::

      {
          'ExportJobPropertiesList': [
              {
                  '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'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ExportJobPropertiesList** *(list) --* 

        The properties of listed FHIR export jobs.

        
        

        - *(dict) --* 

          The properties of a FHIR export job.

          
          

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

            
      
    
      

      - **NextToken** *(string) --* 

        The pagination token used to identify the next page of results to return.

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

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

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

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

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

  