Skip to content

Start a FHIR export job

Description

Start a FHIR export job.

Usage

healthlake_start_fhir_export_job(JobName, OutputDataConfig, DatastoreId,
  DataAccessRoleArn, ClientToken)

Arguments

  • JobName

The export job name.

  • OutputDataConfig

[required] The output data configuration supplied when the export job was started.

  • DatastoreId

[required] The data store identifier from which files are being exported.

  • DataAccessRoleArn

[required] The Amazon Resource Name (ARN) used during initiation of the export job.

  • ClientToken

An optional user provided token used for ensuring API idempotency.

Value

A list with the following syntax:

list(
  JobId = "string",
  JobStatus = "SUBMITTED"|"QUEUED"|"IN_PROGRESS"|"COMPLETED_WITH_ERRORS"|"COMPLETED"|"FAILED"|"CANCEL_SUBMITTED"|"CANCEL_IN_PROGRESS"|"CANCEL_COMPLETED"|"CANCEL_FAILED",
  DatastoreId = "string"
)

Request syntax

svc$start_fhir_export_job(
  JobName = "string",
  OutputDataConfig = list(
    S3Configuration = list(
      S3Uri = "string",
      KmsKeyId = "string"
    )
  ),
  DatastoreId = "string",
  DataAccessRoleArn = "string",
  ClientToken = "string"
)