list-fhir-export-jobs¶

Description¶

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

Synopsis¶

  list-fhir-export-jobs
--datastore-id <value>
[--next-token <value>]
[--max-results <value>]
[--job-name <value>]
[--job-status <value>]
[--submitted-before <value>]
[--submitted-after <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--datastore-id (string)

This parameter limits the response to the export job with the specified Data Store ID.

--next-token (string)

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

--max-results (integer)

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

--job-name (string)

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

--job-status (string)

This parameter limits the response to the export jobs with the specified job status.

Possible values:

SUBMITTED

IN_PROGRESS

COMPLETED_WITH_ERRORS

COMPLETED

FAILED

--submitted-before (timestamp)

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

--submitted-after (timestamp)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To list all FHIR export jobs

The following list-fhir-export-jobs example shows how to use the command to view a list of export jobs associated with an account.

aws healthlake list-fhir-export-jobs \
    --datastore-id (Datastore ID) \
    --submitted-before (DATE like 2024-10-13T19:00:00Z)\
    --submitted-after (DATE like 2020-10-13T19:00:00Z )\
    --job-name "FHIR-EXPORT" \
    --job-status SUBMITTED  \
    --max-results (Integer between 1 and 500)

Output:

{
    "ExportJobProperties": {
        "OutputDataConfig": {
            "S3Uri": "s3://(Bucket Name)/(Prefix Name)/"
                "S3Configuration": {
                "S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
                "KmsKeyId" : "(KmsKey Id)"
        },
    },
    "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
    "JobStatus": "COMPLETED",
    "JobId": "c145fbb27b192af392f8ce6e7838e34f",
    "JobName" "FHIR-EXPORT",
    "SubmitTime": 1606272542.161,
    "EndTime": 1606272609.497,
    "DatastoreId": "(Datastore ID)"
    }
}
"NextToken": String

For more information, see Exporting files from a FHIR Data Store in the Amazon HealthLake Developer Guide.

Output¶

ExportJobPropertiesList -> (list)

The properties of listed FHIR export jobs, including the ID, ARN, name, and the status of the job.

(structure)

The properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

JobId -> (string)

The AWS generated ID for an export job.

JobName -> (string)

The user generated name for an export job.

JobStatus -> (string)

The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.

SubmitTime -> (timestamp)

The time an export job was initiated.

EndTime -> (timestamp)

The time an export job completed.

DatastoreId -> (string)

The AWS generated ID for the Data Store from which files are being exported for an export job.

OutputDataConfig -> (structure)

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

S3Configuration -> (structure)

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

S3Uri -> (string)

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

KmsKeyId -> (string)

The KMS key ID used to access the S3 bucket.

DataAccessRoleArn -> (string)

The Amazon Resource Name used during the initiation of the job.

Message -> (string)

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

NextToken -> (string)