AWS DescribeExportJob
CertifiedDescribe an Amazon HealthLake FHIR export job
AWS DescribeExportJob
Describe an Amazon HealthLake FHIR export job
Returns the current status, timing, output location, and error details of a HealthLake bulk export job.
Pair with Kestra's retry/wait pattern or use the Trigger task to poll for completion automatically.
type: io.kestra.plugin.aws.healthlake.DescribeExportJobExamples
Poll the status of a HealthLake export job.
id: healthlake_describe_export
namespace: company.team
tasks:
- id: describe_export
type: io.kestra.plugin.aws.healthlake.DescribeExportJob
region: "{{ secret('AWS_REGION') }}"
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_ACCESS_KEY') }}"
datastoreId: "{{ secret('HEALTHLAKE_DATASTORE_ID') }}"
jobId: "{{ inputs.job_id }}"
- id: log_status
type: io.kestra.plugin.core.log.Log
message: "Export job status: {{ outputs.describe_export.jobStatus }}"
Properties
datastoreId *string
Data store ID
The ID of the FHIR data store the export job belongs to.
jobId *string
Job ID
The ID of the export job to describe.
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.
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
endTime string
End time
ISO-8601 timestamp when the job finished (null if still running).
jobId string
Job ID
jobName string
Job name
jobStatus string
Job status
One of: SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED, CANCEL_SUBMITTED, CANCEL_IN_PROGRESS, CANCEL_COMPLETED, CANCEL_FAILED.
message string
Message
Error or informational message from the service.
outputS3Uri string
Output S3 URI
S3 URI where the exported FHIR bundles were written.
submitTime string
Submit time
ISO-8601 timestamp when the job was submitted.
