fhir_export_jobs

Creates, updates, deletes, gets or lists a fhir_export_jobs resource.

Overview

Name	fhir_export_jobs
Type	Resource
Id	aws.healthlake.fhir_export_jobs

Fields

The following fields are returned by SELECT queries:

describe_fhir_export_job

Name	Datatype	Description
data_access_role_arn	string	The Amazon Resource Name (ARN) used during the initiation of the export job. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
datastore_id	string	The data store identifier from which files are being exported. (pattern: <code>([\p{L}\p{Z}\p{N}_.:/=+-%@]*)</code>)
end_time	string (date-time)	The time the export job completed.
job_id	string	The export job identifier. (pattern: <code>([\p{L}\p{Z}\p{N}_.:/=+-%@]*)</code>)
job_name	string	The export job name. (pattern: <code>([\p{L}\p{Z}\p{N}_.:/=+-%@]*)</code>)
job_status	string	The export job status. (SUBMITTED, QUEUED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED, CANCEL_SUBMITTED, CANCEL_IN_PROGRESS, CANCEL_COMPLETED, CANCEL_FAILED)
message	string	An explanation of any errors that might have occurred during the export job. (pattern: <code>([\p{L}\p{Z}\p{N}_.:/=+-%@]*)</code>)
output_data_config	object	The output data configuration supplied when the export job was created.
submit_time	string (date-time)	The time the export job was initiated.

list_fhir_export_jobs

Name	Datatype	Description
export_job_properties_list	array	The properties of listed FHIR export jobs.
next_token	string	The pagination token used to identify the next page of results to return. (pattern: <code>\p{ASCII}{0,8192}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_fhir_export_job	select	region		Get FHIR export job properties.
list_fhir_export_jobs	select	region		Lists all FHIR export jobs associated with an account and their statuses.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_fhir_export_job

Get FHIR export job properties.

SELECT
data_access_role_arn,
datastore_id,
end_time,
job_id,
job_name,
job_status,
message,
output_data_config,
submit_time
FROM aws.healthlake.fhir_export_jobs
WHERE region = '{{ region }}' -- required
;

list_fhir_export_jobs

Lists all FHIR export jobs associated with an account and their statuses.

SELECT
export_job_properties_list,
next_token
FROM aws.healthlake.fhir_export_jobs
WHERE region = '{{ region }}' -- required
;