Amazon HealthLake

Begins a FHIR export job.

See also: AWS API Documentation

Request Syntax

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

type JobName

string

param JobName

The user generated name for an export job.

type OutputDataConfig

dict

param OutputDataConfig

[REQUIRED]

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

• S3Uri (string) --

  The S3Uri is the user specified S3 location to which data will be exported from a FHIR Data Store.

type DatastoreId

string

param DatastoreId

[REQUIRED]

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

type DataAccessRoleArn

string

param DataAccessRoleArn

[REQUIRED]

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

type ClientToken

string

param ClientToken

[REQUIRED]

An optional user provided token used for ensuring idempotency.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'JobId': 'string',
    'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'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.

Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

See also: AWS API Documentation

Request Syntax

client.describe_fhir_export_job(
    DatastoreId='string',
    JobId='string'
)

type DatastoreId

string

param DatastoreId

[REQUIRED]

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

type JobId

string

param JobId

[REQUIRED]

The AWS generated ID for an export job.

rtype

dict

returns

Response Syntax

{
    'ExportJobProperties': {
        'JobId': 'string',
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
        'SubmitTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'DatastoreId': 'string',
        'OutputDataConfig': {
            'S3Uri': 'string'
        },
        'DataAccessRoleArn': 'string',
        'Message': 'string'
    }
}

Response Structure

• (dict) --

  • ExportJobProperties (dict) --

    Displays the properties of the export job, including the ID, Arn, Name, and the status of the job.

    • JobId (string) --

      The AWS generated ID for an export job.

    • JobName (string) --

      The user generated name for an export job.

    • JobStatus (string) --

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

    • SubmitTime (datetime) --

      The time an export job was initiated.

    • EndTime (datetime) --

      The time an export job completed.

    • DatastoreId (string) --

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

    • OutputDataConfig (dict) --

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

      • S3Uri (string) --

        The S3Uri is the user specified S3 location to which data will be exported from a FHIR Data Store.

    • DataAccessRoleArn (string) --

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

    • Message (string) --

      An explanation of any errors that may have occurred during the export job.