View a markdown version of this page

DescribeDataTransformationJob - AWS HealthLake

DescribeDataTransformationJob

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

Request Syntax

{ "JobId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

JobId

The unique identifier of the data transformation job to describe.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: [a-zA-Z0-9-]+

Required: Yes

Response Syntax

{ "TransformationJobProperties": { "DataAccessRoleArn": "string", "DriftDetectionEnabled": boolean, "EndTime": number, "InputDataConfig": { "S3Uri": "string", "SourceFormat": "string" }, "JobId": "string", "JobName": "string", "JobProgressReport": { "TotalFilesConverted": number, "TotalFilesFailed": number, "TotalFilesScanned": number, "TotalResourcesGenerated": number }, "JobStatus": "string", "Message": "string", "OutputDataConfig": { "S3Configuration": { "KmsKeyId": "string", "S3Uri": "string" } }, "ProfileId": "string", "ProfileName": "string", "ProfileVersion": number, "ProvenanceEnabled": boolean, "SubmitTime": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

TransformationJobProperties

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

Type: TransformationJobProperties object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Access is denied. Your account is not authorized to perform this operation.

HTTP Status Code: 400

InternalServerException

An unknown internal error occurred in the service.

HTTP Status Code: 500

ResourceNotFoundException

The requested data store was not found.

HTTP Status Code: 400

ThrottlingException

The user has exceeded their maximum number of allowed calls to the given API.

HTTP Status Code: 400

ValidationException

The user input parameter was invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: