v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14137150.1 KB

Begins a FHIR export job.

post/#X-Amz-Target=HealthLake.StartFHIRExportJob

Headers

X-Amz-Target'HealthLake.StartFHIRExportJob' required

Request body

JobNamestring

The user generated name for an export job.

DatastoreIdstring required

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

DataAccessRoleArnstring required

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

ClientTokenstring required

An optional user provided token used for ensuring idempotency.

Response

Success

JobIdstring required

The AWS generated ID for an export job.

JobStatus'SUBMITTED' | 'IN_PROGRESS' | 'COMPLETED_WITH_ERRORS' | 'COMPLETED' | 'FAILED' required

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

DatastoreIdstring

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