AWS HealthLake StartImportJob
Certified
Start an Amazon HealthLake FHIR bulk import job
AWS HealthLake StartImportJob
Start an Amazon HealthLake FHIR bulk import job
Submits a bulk FHIR import job from an S3 URI into a HealthLake data store and returns the job ID.
Use DescribeImportJob to poll for completion, or use the Trigger task to react when it finishes.
type: io.kestra.plugin.aws.healthlake.StartImportJobExamples
Start a FHIR bulk import from S3.
id: healthlake_start_import
namespace: company.team
inputs:
- id: datastore_id
type: STRING
- id: s3_input_uri
type: STRING
tasks:
- id: start_import
type: io.kestra.plugin.aws.healthlake.StartImportJob
region: "{{ secret('AWS_REGION') }}"
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_ACCESS_KEY') }}"
datastoreId: "{{ inputs.datastore_id }}"
inputS3Uri: "{{ inputs.s3_input_uri }}"
outputS3Uri: "s3://my-bucket/healthlake-output/"
dataAccessRoleArn: "{{ secret('HEALTHLAKE_ROLE_ARN') }}"
- id: log_job
type: io.kestra.plugin.core.log.Log
message: "Import job started: {{ outputs.start_import.jobId }}"
Installation
Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:
kestractl plugins get io.kestra.plugin:plugin-aws --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
Properties
dataAccessRoleArn *string
Data access role ARN
IAM role ARN that HealthLake assumes to read from the input S3 bucket and write to the output bucket.
datastoreId *string
Data store ID
The ID of the target FHIR data store.
inputS3Uri *string
Input S3 URI
S3 URI of the FHIR bundle(s) to import, e.g. s3://my-bucket/fhir/.
outputS3Uri *string
Output S3 URI
S3 URI prefix where import job output and error files are written.
accessKeyId string
Access Key Id in order to connect to AWS
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150endpointOverride string
The endpoint with which the SDK should communicate
This property allows you to use a different S3 compatible storage backend.
jobName string
Job name
Optional human-readable name for the import job.
region string
AWS region with which the SDK should communicate
secretKeyId string
Secret Key Id in order to connect to AWS
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
sessionToken string
AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permissions to access a given resource
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
stsEndpointOverride string
The AWS STS endpoint with which the SDKClient should communicate
stsRoleArn string
AWS STS Role
The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
stsRoleExternalId string
AWS STS External Id
A unique identifier that might be required when you assume a role in another account. This property is only used when an stsRoleArn is defined.
stsRoleSessionDuration string
PT15MAWS STS Session duration
The duration of the role session (default: 15 minutes, i.e., PT15M). This property is only used when an stsRoleArn is defined.
stsRoleSessionName string
AWS STS Session name
This property is only used when an stsRoleArn is defined.
webIdentityToken string
OIDC token to assume the STS role with
When set together with stsRoleArn, the role is assumed through AssumeRoleWithWebIdentity and no AWS credentials are needed at all: AWS verifies the token against the identity provider that issued it.
Use {{ oidcToken(audience='sts.amazonaws.com') }} to have Kestra Enterprise mint one for the running execution.
The resulting credentials last stsRoleSessionDuration; the token expression is rendered again at every refresh, so a short-lived token keeps working for a long task.
Outputs
datastoreId string
Data store ID
The data store the job was submitted to.
jobId string
Job ID
The ID of the submitted import job.
jobStatus string
Job status
Initial job status, typically SUBMITTED.