Class: Aws::HealthLake::Types::TransformationJobProperties

Inherits:

Struct

Object
Struct
Aws::HealthLake::Types::TransformationJobProperties

show all

Includes:: Structure

Defined in:: lib/aws-sdk-healthlake/types.rb

Overview

Contains the properties of a data transformation job, including its status, configuration, and progress information. You retrieve this structure by calling DescribeDataTransformationJob.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#data_access_role_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that grants HealthLake access to the specified Amazon S3 locations.
#drift_detection_enabled ⇒ Boolean
Specifies whether drift detection is enabled for this job.
#end_time ⇒ Time
The timestamp when the job completed or failed.
#input_data_config ⇒ Types::TransformationInputDataConfig
The Amazon S3 location and format of the source files for this job.
#job_id ⇒ String
The unique identifier of the data transformation job.
#job_name ⇒ String
The name of the data transformation job.
#job_progress_report ⇒ Types::TransformationJobProgressReport
The progress report for the data transformation job, including counts of files processed and resources generated.
#job_status ⇒ String
The current status of the data transformation job.
#message ⇒ String
An informational message about the job, such as an error description if the job failed.
#output_data_config ⇒ Types::TransformationOutputDataConfig
The Amazon S3 location and encryption configuration for the converted output.
#profile_id ⇒ String
The unique identifier of the data transformation profile used for this job.
#profile_name ⇒ String
The name of the data transformation profile used for this job.
#profile_version ⇒ Integer
The version number of the data transformation profile used for this job.
#provenance_enabled ⇒ Boolean
Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job.
#submit_time ⇒ Time
The timestamp when the job was submitted.

Instance Attribute Details

#data_access_role_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#drift_detection_enabled ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ `Time`

The timestamp when the job completed or failed.

Returns:

(Time)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_config ⇒ `Types::TransformationInputDataConfig`

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

Returns:

(Types::TransformationInputDataConfig)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ `String`

The unique identifier of the data transformation job.

Returns:

(String)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ `String`

The name of the data transformation job.

Returns:

(String)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#job_progress_report ⇒ `Types::TransformationJobProgressReport`

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

Returns:

(Types::TransformationJobProgressReport)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#job_status ⇒ `String`

The current status of the data transformation job.

Returns:

(String)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_config ⇒ `Types::TransformationOutputDataConfig`

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

Returns:

(Types::TransformationOutputDataConfig)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#profile_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#profile_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#profile_version ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#provenance_enabled ⇒ `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.

Returns:

(Boolean)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

#submit_time ⇒ `Time`

The timestamp when the job was submitted.

Returns:

(Time)

# File 'lib/aws-sdk-healthlake/types.rb', line 2534

class TransformationJobProperties < Struct.new(
  :job_id,
  :job_status,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :submit_time,
  :job_name,
  :profile_id,
  :profile_name,
  :profile_version,
  :end_time,
  :drift_detection_enabled,
  :provenance_enabled,
  :message,
  :job_progress_report)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::HealthLake::Types::TransformationJobProperties

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#data_access_role_arn ⇒ String

#drift_detection_enabled ⇒ Boolean

#end_time ⇒ Time

#input_data_config ⇒ Types::TransformationInputDataConfig

#job_id ⇒ String

#job_name ⇒ String

#job_progress_report ⇒ Types::TransformationJobProgressReport

#job_status ⇒ String

#message ⇒ String

#output_data_config ⇒ Types::TransformationOutputDataConfig

#profile_id ⇒ String

#profile_name ⇒ String

#profile_version ⇒ Integer

#provenance_enabled ⇒ Boolean

#submit_time ⇒ Time

#data_access_role_arn ⇒ `String`

#drift_detection_enabled ⇒ `Boolean`

#end_time ⇒ `Time`

#input_data_config ⇒ `Types::TransformationInputDataConfig`

#job_id ⇒ `String`

#job_name ⇒ `String`

#job_progress_report ⇒ `Types::TransformationJobProgressReport`

#job_status ⇒ `String`

#message ⇒ `String`

#output_data_config ⇒ `Types::TransformationOutputDataConfig`

#profile_id ⇒ `String`

#profile_name ⇒ `String`

#profile_version ⇒ `Integer`

#provenance_enabled ⇒ `Boolean`

#submit_time ⇒ `Time`