AWS StartExportJob
CertifiedStart an Amazon HealthLake FHIR bulk export job
AWS StartExportJob
Start an Amazon HealthLake FHIR bulk export job
Submits a bulk FHIR export job from a HealthLake data store to an S3 destination and returns the job ID.
Use DescribeExportJob to poll for completion, or use the Trigger task to react when it finishes.
type: io.kestra.plugin.aws.healthlake.StartExportJobExamples
Start a FHIR bulk export to S3.
id: healthlake_start_export
namespace: company.team
inputs:
- id: datastore_id
type: STRING
tasks:
- id: start_export
type: io.kestra.plugin.aws.healthlake.StartExportJob
region: "{{ secret('AWS_REGION') }}"
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_ACCESS_KEY') }}"
datastoreId: "{{ inputs.datastore_id }}"
outputS3Uri: "s3://my-bucket/healthlake-export/"
dataAccessRoleArn: "{{ secret('HEALTHLAKE_ROLE_ARN') }}"
- id: log_job
type: io.kestra.plugin.core.log.Log
message: "Export job started: {{ outputs.start_export.jobId }}"
Properties
dataAccessRoleArn *Requiredstring
Data access role ARN
IAM role ARN that HealthLake assumes to write to the output S3 bucket.
datastoreId *Requiredstring
Data store ID
The ID of the FHIR data store to export from.
outputS3Uri *Requiredstring
Output S3 URI
S3 URI prefix where the exported FHIR bundles 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.
compatibilityMode booleanstring
Enable compatibility mode
Use it to connect to S3 bucket with S3 compatible services that don't support the new transport client.
endpointOverride string
The endpoint with which the SDK should communicate
This property allows you to use a different S3 compatible storage backend.
forcePathStyle booleanstring
Force path style access
Must only be used when compatibilityMode is enabled.
jobName string
Job name
Optional human-readable name for the export job.
kmsKeyId string
KMS key ID
Optional KMS key ID for server-side encryption of the export output.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
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.
Outputs
datastoreId string
Data store ID
The data store the job was submitted from.
jobId string
Job ID
The ID of the submitted export job.
jobStatus string
Job status
Initial job status, typically SUBMITTED.
