Comprehend / Client / stop_pii_entities_detection_job

stop_pii_entities_detection_job#

Comprehend.Client.stop_pii_entities_detection_job(**kwargs)#

Stops a PII entities detection job in progress.

See also: AWS API Documentation

Request Syntax

response = client.stop_pii_entities_detection_job(
    JobId='string'
)
Parameters:

JobId (string) –

[REQUIRED]

The identifier of the PII entities detection job to stop.

Return type:

dict

Returns:

Response Syntax

{
    'JobId': 'string',
    'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}

Response Structure

  • (dict) –

    • JobId (string) –

      The identifier of the PII entities detection job to stop.

    • JobStatus (string) –

      The status of the PII entities detection job.

Exceptions

  • Comprehend.Client.exceptions.InvalidRequestException

  • Comprehend.Client.exceptions.JobNotFoundException

  • Comprehend.Client.exceptions.InternalServerException