Amazon Comprehend
Developer Guide

ListPHIDetectionJobs

Gets a list of protected health information (PHI) detection jobs that you have submitted.

Request Syntax

{ "Filter": { "JobName": "string", "JobStatus": "string", "SubmitTimeAfter": number, "SubmitTimeBefore": number }, "MaxResults": number, "NextToken": "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.

Filter

Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

Type: ComprehendMedicalAsyncJobFilter object

Required: No

MaxResults

The maximum number of results to return in each page. The default is 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

NextToken

Identifies the next page of results to return.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{ "ComprehendMedicalAsyncJobPropertiesList": [ { "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 } ], "NextToken": "string" }

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.

ComprehendMedicalAsyncJobPropertiesList

A list containing the properties of each job returned.

Type: Array of ComprehendMedicalAsyncJobProperties objects

NextToken

Identifies the next page of results to return.

Type: String

Length Constraints: Minimum length of 1.

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

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

ValidationException

The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.

HTTP Status Code: 400

See Also

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