HealthLake / Client / start_fhir_export_job

start_fhir_export_job#

HealthLake.Client.start_fhir_export_job(**kwargs)#

Begins a FHIR export job.

See also: AWS API Documentation

Request Syntax

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

  • JobName (string) – The user generated name for an export job.

  • OutputDataConfig (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 ID for the Data Store from which files are being exported for an export job.

  • DataAccessRoleArn (string) –

    [REQUIRED]

    The Amazon Resource Name used during the initiation of the job.

  • ClientToken (string) –

    [REQUIRED]

    An 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 ID for an export job.

    • JobStatus (string) –

      The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.

    • DatastoreId (string) –

      The AWS generated ID for the Data Store from which files are being exported for an export job.

Exceptions

  • HealthLake.Client.exceptions.ValidationException

  • HealthLake.Client.exceptions.ThrottlingException

  • HealthLake.Client.exceptions.AccessDeniedException

  • HealthLake.Client.exceptions.ResourceNotFoundException

  • HealthLake.Client.exceptions.InternalServerException