Amazon Comprehend
Developer Guide

ComprehendMedicalAsyncJobProperties

Provides information about a detection job.

Contents

DataAccessRoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Required: No

EndTime

The time that the detection job completed.

Type: Timestamp

Required: No

ExpirationTime

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.

Type: Timestamp

Required: No

InputDataConfig

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

Type: InputDataConfig object

Required: No

JobId

The identifier assigned to the detection job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Required: No

JobName

The name that you assigned to the detection job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Required: No

JobStatus

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

Type: String

Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | PARTIAL_SUCCESS | FAILED | STOP_REQUESTED | STOPPED

Required: No

KMSKey

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: .*

Required: No

LanguageCode

The language code of the input documents.

Type: String

Valid Values: en

Required: No

ManifestFilePath

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

Message

A description of the status of a job.

Type: String

Required: No

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.

Type: String

Required: No

OutputDataConfig

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

Type: OutputDataConfig object

Required: No

SubmitTime

The time that the detection job was submitted for processing.

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: