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

Inherits:

Struct

• Object
• Struct
• Aws::ComprehendMedical::Types::ComprehendMedicalAsyncJobProperties

Defined in:

gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb

Overview

Provides information about a detection job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_access_role_arn ⇒ String

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

• #end_time ⇒ Time

  The time that the detection job completed.

• #expiration_time ⇒ Time

  The date and time that job metadata is deleted from the server.

• #input_data_config ⇒ Types::InputDataConfig

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

• #job_id ⇒ String

  The identifier assigned to the detection job.

• #job_name ⇒ String

  The name that you assigned to the detection job.

• #job_status ⇒ String

  The current status of the detection job.

• #kms_key ⇒ String

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

• #language_code ⇒ String

  The language code of the input documents.

• #manifest_file_path ⇒ String

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

• #message ⇒ String

  A description of the status of a job.

• #model_version ⇒ String

  The version of the model used to analyze the documents.

• #output_data_config ⇒ Types::OutputDataConfig

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

• #submit_time ⇒ Time

  The time that the detection job was submitted for processing.

Instance Attribute Details

#data_access_role_arn ⇒ String

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

Returns:

• (String)

# 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_time ⇒ Time

The time that the detection job completed.

Returns:

• (Time)

# 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_time ⇒ Time

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)

# 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_config ⇒ Types::InputDataConfig

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

Returns:

• (Types::InputDataConfig)

# 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_id ⇒ String

The identifier assigned to the detection job.

Returns:

• (String)

# 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_name ⇒ String

The name that you assigned to the detection job.

Returns:

• (String)

# 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_status ⇒ String

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

Returns:

• (String)

# 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_key ⇒ String

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

Returns:

• (String)

# 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_code ⇒ String

The language code of the input documents.

Returns:

• (String)

# 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_path ⇒ String

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

Returns:

• (String)

# 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

#message ⇒ String

A description of the status of a job.

Returns:

• (String)

# 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_version ⇒ String

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)

# 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_config ⇒ Types::OutputDataConfig

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

Returns:

• (Types::OutputDataConfig)

# 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_time ⇒ Time

The time that the detection job was submitted for processing.

Returns:

• (Time)

# 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