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

*********************
start_fhir_export_job
*********************



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

  

  Start a FHIR export job.

  

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


  **Request Syntax**
  ::

    response = client.start_fhir_export_job(
        JobName='string',
        OutputDataConfig={
            'S3Configuration': {
                'S3Uri': 'string',
                'KmsKeyId': 'string'
            }
        },
        DatastoreId='string',
        DataAccessRoleArn='string',
        ClientToken='string'
    )
    
  :type JobName: string
  :param JobName: 

    The export job name.

    

  
  :type OutputDataConfig: dict
  :param OutputDataConfig: **[REQUIRED]** 

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

    .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``S3Configuration``. 

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

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

      

    
      - **S3Uri** *(string) --* **[REQUIRED]** 

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

        

      
      - **KmsKeyId** *(string) --* **[REQUIRED]** 

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

        

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

    The data store identifier from which files are being exported.

    

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

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

    

  
  :type ClientToken: string
  :param ClientToken: 

    An optional user provided token used for ensuring API idempotency.

    This field is autopopulated if not provided.

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

    
    ::

      {
          'JobId': 'string',
          'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
          'DatastoreId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The export job identifier.

        
      

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

        The export job status.

        
      

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

        The data store identifier from which files are being exported.

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

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

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

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

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

  