AWS DescribeExportJob

AWS DescribeExportJob
Certified
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.

yaml
type: io.kestra.plugin.aws.healthlake.DescribeExportJob

Examples

Poll the status of a HealthLake export job.

yaml
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.

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.

pluginDefaultsRef string

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

DefaultPT15M

AWS 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.