HealthLake / Client / start_fhir_import_job

start_fhir_import_job

HealthLake.Client.start_fhir_import_job(**kwargs)

Start importing bulk FHIR data into an ACTIVE data store. The import job imports FHIR data found in the InputDataConfig object and stores processing results in the JobOutputDataConfig object.

See also: AWS API Documentation

Request Syntax

response = client.start_fhir_import_job(
    JobName='string',
    InputDataConfig={
        'S3Uri': 'string'
    },
    JobOutputDataConfig={
        'S3Configuration': {
            'S3Uri': 'string',
            'KmsKeyId': 'string'
        }
    },
    DatastoreId='string',
    DataAccessRoleArn='string',
    ClientToken='string',
    ValidationLevel='strict'|'structure-only'|'minimal'
)
Parameters:

  • JobName (string) – The import job name.

  • InputDataConfig (dict) –

    [REQUIRED]

    The input properties for the import job request.

    Note

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

    • S3Uri (string) –

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

  • JobOutputDataConfig (dict) –

    [REQUIRED]

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

  • DatastoreId (string) –

    [REQUIRED]

    The data store identifier.

  • DataAccessRoleArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.

  • ClientToken (string) –

    The optional user-provided token used for ensuring API idempotency.

    This field is autopopulated if not provided.

  • ValidationLevel (string) – The validation level of the import job.

Return type:

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 import job identifier.

    • JobStatus (string) –

      The import job status.

    • DatastoreId (string) –

      The data store identifier.

Exceptions