HealthLake / Client / start_fhir_import_job

start_fhir_import_job

HealthLake.Client.start_fhir_import_job(**kwargs)

Begins a FHIR Import job.

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'
)

Parameters:

• JobName (string) – The name of the FHIR Import job in the StartFHIRImport job request.

• InputDataConfig (dict) –

  [REQUIRED]

  The input properties of the FHIR Import job in the StartFHIRImport 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 Amazon HealthLake.

• JobOutputDataConfig (dict) –

  [REQUIRED]

  The output data configuration that was 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 that was 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 Amazon HealthLake.

    • KmsKeyId (string) – [REQUIRED]

      The KMS key ID used to access the S3 bucket.

• DatastoreId (string) –

  [REQUIRED]

  The AWS-generated Data Store ID.

• DataAccessRoleArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.

• ClientToken (string) –

  [REQUIRED]

  Optional user provided token used for ensuring idempotency.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • JobId (string) –

    The AWS-generated job ID.

  • JobStatus (string) –

    The status of an import job.

  • DatastoreId (string) –

    The AWS-generated Data Store ID.

Exceptions

• HealthLake.Client.exceptions.ValidationException

• HealthLake.Client.exceptions.ThrottlingException

• HealthLake.Client.exceptions.AccessDeniedException

• HealthLake.Client.exceptions.ResourceNotFoundException

• HealthLake.Client.exceptions.InternalServerException