Describe F H I R Export Job
healthlake.describe_fhir_export_job
ActionAmazon Web Servicesconnection required
Calls the AWS healthlake API (SigV4).
Get FHIR export job properties.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Amazon HealthLake
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
region AWS region (overrides the connection). | string | No | — | — | — |
datastore_id The data store identifier from which FHIR data is being exported from. | string | Yes | — | — | — |
job_id The export job identifier. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ExportJobProperties | object | — |
{
"ExportJobProperties": {}
}Related Amazon HealthLake nodes
See Describe F H I R Export Job run in a workflow.
In a technical demo we add the Amazon HealthLake connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.