[ aws . healthlake ]
list-fhir-export-jobs¶
Description¶
Lists all FHIR export jobs associated with an account and their statuses.
See also: AWS API Documentation
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>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
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 -> (tagged union structure)
The output data configuration that was supplied when the export job was created.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
S3Configuration.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)
A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.