Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ComprehendMedicalAsyncJobProperties

Provides information about a detection job.

Hierarchy

  • ComprehendMedicalAsyncJobProperties

Index

Properties

Optional DataAccessRoleArn

DataAccessRoleArn: undefined | string

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

Optional EndTime

EndTime: Date

The time that the detection job completed.

Optional ExpirationTime

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.

Optional InputDataConfig

InputDataConfig: InputDataConfig

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

Optional JobId

JobId: undefined | string

The identifier assigned to the detection job.

Optional JobName

JobName: undefined | string

The name that you assigned to the detection job.

Optional JobStatus

JobStatus: JobStatus | string

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

Optional KMSKey

KMSKey: undefined | string

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

Optional LanguageCode

LanguageCode: LanguageCode | string

The language code of the input documents.

Optional ManifestFilePath

ManifestFilePath: undefined | string

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

Optional Message

Message: undefined | string

A description of the status of a job.

Optional ModelVersion

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

Optional OutputDataConfig

OutputDataConfig: OutputDataConfig

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

Optional SubmitTime

SubmitTime: Date

The time that the detection job was submitted for processing.