Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

See 'aws help' for descriptions of global parameters.

Examples

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, and the status 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, 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 -> (structure)

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

S3Uri -> (string)

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

JobOutputDataConfig -> (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 (ARN) that gives Amazon HealthLake access to your input data.

Message -> (string)

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