Class: Aws::ComprehendMedical::Types::ComprehendMedicalAsyncJobProperties

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb

Overview

Provides information about a detection job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_access_role_arnString

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.

Returns:

  • (String)


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#end_timeTime

The time that the detection job completed.

Returns:

  • (Time)


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#expiration_timeTime

The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.

Returns:

  • (Time)


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_configTypes::InputDataConfig

The input data configuration that you supplied when you created the detection job.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#job_idString

The identifier assigned to the detection job.

Returns:

  • (String)


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#job_nameString

The name that you assigned to the detection job.

Returns:

  • (String)


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#job_statusString

The current status of the detection job. If the status is FAILED, the Message field shows the reason for the failure.

Returns:

  • (String)


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#kms_keyString

The AWS Key Management Service key, if any, used to encrypt the output files.

Returns:

  • (String)


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

The language code of the input documents.

Returns:

  • (String)


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#manifest_file_pathString

The path to the file that describes the results of a batch job.

Returns:

  • (String)


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#messageString

A description of the status of a job.

Returns:

  • (String)


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#model_versionString

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

Returns:

  • (String)


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_configTypes::OutputDataConfig

The output data configuration that you supplied when you created the detection job.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#submit_timeTime

The time that the detection job was submitted for processing.

Returns:

  • (Time)


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 203

class ComprehendMedicalAsyncJobProperties < Struct.new(
  :job_id,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :expiration_time,
  :input_data_config,
  :output_data_config,
  :language_code,
  :data_access_role_arn,
  :manifest_file_path,
  :kms_key,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end