Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface ComprehendMedicalAsyncJobProperties

Provides information about a detection job.

Hierarchy

  • ComprehendMedicalAsyncJobProperties

Properties

DataAccessRoleArn?: string

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

EndTime?: Date

The time that the detection job completed.

ExpirationTime?: Date

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.

InputDataConfig?: InputDataConfig

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

JobId?: string

The identifier assigned to the detection job.

JobName?: string

The name that you assigned to the detection job.

JobStatus?: string

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

KMSKey?: string

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

LanguageCode?: string

The language code of the input documents.

ManifestFilePath?: string

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

Message?: string

A description of the status of a job.

ModelVersion?: 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.

OutputDataConfig?: OutputDataConfig

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

SubmitTime?: Date

The time that the detection job was submitted for processing.