Amazon Comprehend
Developer Guide

DescribePHIDetectionJob

Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.

Request Syntax

{ "JobId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

JobId

The identifier that Amazon Comprehend Medical generated for the job. The StartPHIDetectionJob operation returns this identifier in its response.

Type: String

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

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

Required: Yes

Response Syntax

{ "ComprehendMedicalAsyncJobProperties": { "DataAccessRoleArn": "string", "EndTime": number, "ExpirationTime": number, "InputDataConfig": { "S3Bucket": "string", "S3Key": "string" }, "JobId": "string", "JobName": "string", "JobStatus": "string", "KMSKey": "string", "LanguageCode": "string", "ManifestFilePath": "string", "Message": "string", "ModelVersion": "string", "OutputDataConfig": { "S3Bucket": "string", "S3Key": "string" }, "SubmitTime": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ComprehendMedicalAsyncJobProperties

An object that contains the properties associated with a detection job.

Type: ComprehendMedicalAsyncJobProperties object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

InvalidRequestException

The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

HTTP Status Code: 400

ResourceNotFoundException

The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.

HTTP Status Code: 400

TooManyRequestsException

You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.

HTTP Status Code: 400

See Also

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