[ aws . healthlake ]

describe-fhir-export-job

Description

Displays the properties of a FHIR export 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-export-job
--datastore-id <value>
--job-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--datastore-id (string)

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

--job-id (string)

The AWS generated ID for an export job.

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

The following describe-fhir-export-job example shows how to find the properties of a FHIR export job in Amazon HealthLake.

aws healthlake describe-fhir-export-job \
    --datastore-id (Datastore ID) \
    --job-id 9b9a51943afaedd0a8c0c26c49135a31

Output:

{
    "ExportJobProperties": {
        "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
        "JobStatus": "IN_PROGRESS",
        "JobId": "9009813e9d69ba7cf79bcb3468780f16",
        "SubmitTime": 1609175692.715,
        "OutputDataConfig": {
            "S3Uri": "s3://(Bucket Name)/(Prefix Name)/59593b2d0367ce252b5e66bf5fd6b574-FHIR_EXPORT-9009813e9d69ba7cf79bcb3468780f16/"
        },
        "DatastoreId": "(Datastore ID)"
    }
}

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

Output

ExportJobProperties -> (structure)

Displays the properties of the 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.