Skip to content

ComprehendMedicalAsyncJobProperties

Source code in docs_src/capo_comprehendmedical/types/comprehend_medical_async_job_properties.py
class ComprehendMedicalAsyncJobProperties(TypedDict, closed=True):
    job_id: NotRequired["capo_comprehendmedical.types.job_id.JobId"]
    """<p>The identifier assigned to the detection job.</p>"""
    job_name: NotRequired["capo_comprehendmedical.types.job_name.JobName"]
    """<p>The name that you assigned to the detection job.</p>"""
    job_status: NotRequired["capo_comprehendmedical.types.job_status.JobStatus"]
    """<p>The current status of the detection job. If the status is <code>FAILED</code>, the <code>Message</code> field shows the reason for the failure.</p>"""
    message: NotRequired[
        "capo_comprehendmedical.types.any_length_string.AnyLengthString"
    ]
    """<p>A description of the status of a job.</p>"""
    submit_time: NotRequired["capo_comprehendmedical.types.timestamp.Timestamp"]
    """<p>The time that the detection job was submitted for processing.</p>"""
    end_time: NotRequired["capo_comprehendmedical.types.timestamp.Timestamp"]
    """<p>The time that the detection job completed.</p>"""
    expiration_time: NotRequired["capo_comprehendmedical.types.timestamp.Timestamp"]
    """<p>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 <code>ListEntitiesDetectionV2Job</code> or the <code>ListPHIDetectionJobs</code> operation.</p>"""
    input_data_config: NotRequired[
        "capo_comprehendmedical.types.input_data_config.InputDataConfig"
    ]
    """<p>The input data configuration that you supplied when you created the detection job.</p>"""
    output_data_config: NotRequired[
        "capo_comprehendmedical.types.output_data_config.OutputDataConfig"
    ]
    """<p>The output data configuration that you supplied when you created the detection job.</p>"""
    language_code: NotRequired[
        "capo_comprehendmedical.types.language_code.LanguageCode"
    ]
    """<p>The language code of the input documents.</p>"""
    data_access_role_arn: NotRequired[
        "capo_comprehendmedical.types.iam_role_arn.IamRoleArn"
    ]
    """<p>The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.</p>"""
    manifest_file_path: NotRequired[
        "capo_comprehendmedical.types.manifest_file_path.ManifestFilePath"
    ]
    """<p>The path to the file that describes the results of a batch job.</p>"""
    kms_key: NotRequired["capo_comprehendmedical.types.kms_key.KMSKey"]
    """<p>The AWS Key Management Service key, if any, used to encrypt the output files. </p>"""
    model_version: NotRequired[
        "capo_comprehendmedical.types.model_version.ModelVersion"
    ]
    """<p>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.</p>"""

data_access_role_arn instance-attribute

data_access_role_arn: NotRequired[IamRoleArn]

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

end_time instance-attribute

end_time: NotRequired[Timestamp]

The time that the detection job completed.

expiration_time instance-attribute

expiration_time: NotRequired[Timestamp]

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.

input_data_config instance-attribute

input_data_config: NotRequired[InputDataConfig]

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

job_id instance-attribute

job_id: NotRequired[JobId]

The identifier assigned to the detection job.

job_name instance-attribute

job_name: NotRequired[JobName]

The name that you assigned to the detection job.

job_status instance-attribute

job_status: NotRequired[JobStatus]

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

kms_key instance-attribute

kms_key: NotRequired[KMSKey]

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

language_code instance-attribute

language_code: NotRequired[LanguageCode]

The language code of the input documents.

manifest_file_path instance-attribute

manifest_file_path: NotRequired[ManifestFilePath]

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

message instance-attribute

message: NotRequired[AnyLengthString]

A description of the status of a job.

model_version instance-attribute

model_version: NotRequired[ModelVersion]

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.

output_data_config instance-attribute

output_data_config: NotRequired[OutputDataConfig]

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

submit_time instance-attribute

submit_time: NotRequired[Timestamp]

The time that the detection job was submitted for processing.