AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . healthlake ]

describe-data-transformation-job

Description

Describes a data transformation job, including its current status, configuration, and progress information.

See also: AWS API Documentation

Synopsis

  describe-data-transformation-job
--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>]
[--v2-debug]

Options

--job-id (string)

The unique identifier of the data transformation job to describe.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

TransformationJobProperties -> (structure)

The properties of the data transformation job, including status, configuration, and progress information.

JobId -> (string)

The unique identifier of the data transformation job.

JobStatus -> (string)

The current status of the data transformation job.

InputDataConfig -> (structure)

The Amazon S3 location and format of the source files for this job.

S3Uri -> (string)

The Amazon S3 URI of the input data to transform.

SourceFormat -> (string)

The format of the source data files (C-CDA or CSV).

OutputDataConfig -> (structure)

The Amazon S3 location and encryption configuration for the converted output.

S3Configuration -> (structure)

The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.

S3Uri -> (string)

The Amazon S3 URI where AWS HealthLake writes the converted output files.

KmsKeyId -> (string)

The AWS Key Management Service (AWS KMS) key identifier used to encrypt the transformation job output written to Amazon S3.

DataAccessRoleArn -> (string)

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants AWS HealthLake access to the specified Amazon S3 locations. AWS HealthLake assumes this role to read input files and write output files.

SubmitTime -> (timestamp)

The timestamp when the job was submitted.

JobName -> (string)

The name of the data transformation job.

ProfileId -> (string)

The unique identifier of the data transformation profile used for this job.

ProfileName -> (string)

The name of the data transformation profile used for this job.

ProfileVersion -> (integer)

The version number of the data transformation profile used for this job.

EndTime -> (timestamp)

The timestamp when the job completed or failed.

DriftDetectionEnabled -> (boolean)

Specifies whether drift detection is enabled for this job. When enabled, AWS HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.

ProvenanceEnabled -> (boolean)

Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources.

Message -> (string)

An informational message about the job, such as an error description if the job failed.

JobProgressReport -> (structure)

The progress report for the data transformation job, including counts of files processed and resources generated.

TotalFilesScanned -> (long)

The total number of source files scanned by the job.

TotalFilesConverted -> (long)

The total number of source files successfully converted.

TotalFilesFailed -> (long)

The total number of source files that failed conversion.

TotalResourcesGenerated -> (long)

The total number of FHIR R4 resources generated across all converted files.