Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribePiiEntitiesDetectionJob

Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.

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 generated for the job. The StartPiiEntitiesDetectionJob 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


{
   "PiiEntitiesDetectionJobProperties": { 
      "DataAccessRoleArn": "string",
      "EndTime": number,
      "InputDataConfig": { 
         "DocumentReaderConfig": { 
            "DocumentReadAction": "string",
            "DocumentReadMode": "string",
            "FeatureTypes": [ "string" ]
         },
         "InputFormat": "string",
         "S3Uri": "string"
      },
      "JobArn": "string",
      "JobId": "string",
      "JobName": "string",
      "JobStatus": "string",
      "LanguageCode": "string",
      "Message": "string",
      "Mode": "string",
      "OutputDataConfig": { 
         "KmsKeyId": "string",
         "S3Uri": "string"
      },
      "RedactionConfig": { 
         "MaskCharacter": "string",
         "MaskMode": "string",
         "PiiEntityTypes": [ "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.

PiiEntitiesDetectionJobProperties

Provides information about a PII entities detection job.

Type: PiiEntitiesDetectionJobProperties 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 is invalid.

Detail: Provides additional detail about why the request failed.

HTTP Status Code: 400

JobNotFoundException

The specified job was not found. Check the job ID and try again.

HTTP Status Code: 400

TooManyRequestsException

The number of requests exceeds the limit. Resubmit your request later.

HTTP Status Code: 400