Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . healthlake ]

describe-fhir-import-job¶

Description¶

Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.

Synopsis¶

  describe-fhir-import-job
--datastore-id <value>
--job-id <value>
[--cli-input-json <value>]
[--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>]

Options¶

--datastore-id (string)

The AWS-generated ID of the data store.

--job-id (string)

The AWS-generated job ID.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

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 describe a FHIR import job

The following describe-fhir-import-job example shows how to learn the properties of a FHIR import job using Amazon HealthLake.

aws healthlake describe-fhir-import-job \
    --datastore-id (Datastore ID) \
    --job-id c145fbb27b192af392f8ce6e7838e34f \
    --region us-east-1

Output:

{
    "ImportJobProperties": {
    "InputDataConfig": {
        "S3Uri": "s3://(Bucket Name)/(Prefix Name)/"
        { "arrayitem2": 2 }
    },
    "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
    "JobStatus": "COMPLETED",
    "JobId": "c145fbb27b192af392f8ce6e7838e34f",
    "SubmitTime": 1606272542.161,
    "EndTime": 1606272609.497,
    "DatastoreId": "(Datastore ID)"
    }
}

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

Output¶

ImportJobProperties -> (structure)

The properties of the Import job request, including the ID, ARN, name, status of the job, and the progress report of the job.

JobId -> (string)

The AWS-generated id number for the Import job.

JobName -> (string)

The user-generated name for an Import job.

JobStatus -> (string)

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

SubmitTime -> (timestamp)

The time that the Import job was submitted for processing.

EndTime -> (timestamp)

The time that the Import job was completed.

DatastoreId -> (string)

The datastore id used when the Import job was created.

InputDataConfig -> (tagged union structure)

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

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: S3Uri.

S3Uri -> (string)

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

JobOutputDataConfig -> (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 AWS HealthLake.

KmsKeyId -> (string)

The KMS key ID used to access the S3 bucket.

JobProgressReport -> (structure)

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

TotalNumberOfScannedFiles -> (long)

The number of files scanned from input S3 bucket.

TotalSizeOfScannedFilesInMB -> (double)

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

TotalNumberOfImportedFiles -> (long)

The number of files imported so far.

TotalNumberOfResourcesScanned -> (long)

The number of resources scanned from the input S3 bucket.

TotalNumberOfResourcesImported -> (long)

The number of resources imported so far.

TotalNumberOfResourcesWithCustomerError -> (long)

The number of resources that failed due to customer error.

TotalNumberOfFilesReadWithCustomerError -> (long)

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

Throughput -> (double)

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

DataAccessRoleArn -> (string)

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

Message -> (string)

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

Table Of Contents

Feedback

User Guide

Note:

describe-fhir-import-job¶

Description¶

Synopsis¶

Options¶

Global Options¶

Examples¶

Note

Output¶

Note

Note