Skip to content
AWS for Query.Farm

aws.healthlake.list_fhir_import_jobs

Example SQL Queries

SELECT * FROM
aws.healthlake.list_fhir_import_jobs
WHERE
"datastore_id" = 'VALUE';

Description

Lists all FHIR import jobs associated with an account and their statuses.

Table Definition

Column NameColumn Data Type
datastore_id Required Input Column

This parameter limits the response to the import job with the specified data store ID. 

VARCHAR
job_name Input Column

This parameter limits the response to the import job with the specified job name. 

VARCHAR
job_status Input Column

This parameter limits the response to the import job with the specified job status. 

VARCHAR
max_results Input Column

This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user. 

BIGINT
next_token Input Column

A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query. 

VARCHAR
submitted_after Input Column

This parameter limits the response to FHIR import jobs submitted after a user specified date. 

TIMESTAMP_S
submitted_before Input Column

This parameter limits the response to FHIR import jobs submitted before a user specified date. 

TIMESTAMP_S
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
import_job_properties_list

The properties of a listed FHIR import jobs, including the ID, ARN, name, the status of the job, and the progress report of the job. 

STRUCT(
    "job_id" VARCHAR,
    "job_name" VARCHAR,
    "job_status" VARCHAR,
    "submit_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "datastore_id" VARCHAR,
    "input_data_config" STRUCT(
        "s3_uri" VARCHAR
    ),
    "job_output_data_config" STRUCT(
        "s3_configuration" STRUCT(
            "s3_uri" VARCHAR,
            "kms_key_id" VARCHAR
        )
    ),
    "job_progress_report" STRUCT(
        "total_number_of_scanned_files" BIGINT,
        "total_size_of_scanned_files_in_mb" DOUBLE,
        "total_number_of_imported_files" BIGINT,
        "total_number_of_resources_scanned" BIGINT,
        "total_number_of_resources_imported" BIGINT,
        "total_number_of_resources_with_customer_error" BIGINT,
        "total_number_of_files_read_with_customer_error" BIGINT,
        "throughput" DOUBLE
    ),
    "data_access_role_arn" VARCHAR,
    "message" VARCHAR
)[]
Show child fields
import_job_properties_list[]
Show child fields
import_job_properties_list[].data_access_role_arn

The Amazon Resource Name (ARN) that gives AWS HealthLake access to your input data.

import_job_properties_list[].datastore_id

The datastore id used when the Import job was created.

import_job_properties_list[].end_time

The time that the Import job was completed.

import_job_properties_list[].input_data_config

The input data configuration that was supplied when the Import job was created.

Show child fields
import_job_properties_list[].input_data_config.s3_uri

The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.

import_job_properties_list[].job_id

The AWS-generated id number for the Import job.

import_job_properties_list[].job_name

The user-generated name for an Import job.

import_job_properties_list[].job_output_data_config

The output data configuration that was supplied when the export job was created.

Show child fields
import_job_properties_list[].job_output_data_config.s3_configuration

The output data configuration that was supplied when the export job was created.

Show child fields
import_job_properties_list[].job_output_data_config.s3_configuration.kms_key_id

The KMS key ID used to access the S3 bucket.

import_job_properties_list[].job_output_data_config.s3_configuration.s3_uri

The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.

import_job_properties_list[].job_progress_report

Displays the progress of the import job, including total resources scanned, total resources ingested, and total size of data ingested.

Show child fields
import_job_properties_list[].job_progress_report.throughput

The throughput (in MB/sec) of the import job.

import_job_properties_list[].job_progress_report.total_number_of_files_read_with_customer_error

The number of files that failed to be read from the input S3 bucket due to customer error.

import_job_properties_list[].job_progress_report.total_number_of_imported_files

The number of files imported so far.

import_job_properties_list[].job_progress_report.total_number_of_resources_imported

The number of resources imported so far.

import_job_properties_list[].job_progress_report.total_number_of_resources_scanned

The number of resources scanned from the input S3 bucket.

import_job_properties_list[].job_progress_report.total_number_of_resources_with_customer_error

The number of resources that failed due to customer error.

import_job_properties_list[].job_progress_report.total_number_of_scanned_files

The number of files scanned from input S3 bucket.

import_job_properties_list[].job_progress_report.total_size_of_scanned_files_in_mb

The size (in MB) of the files scanned from the input S3 bucket.

import_job_properties_list[].job_status

The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED.

import_job_properties_list[].message

An explanation of any errors that may have occurred during the FHIR import job.

import_job_properties_list[].submit_time

The time that the Import job was submitted for processing.