stop_phi_detection_job

ComprehendMedical.Client.stop_phi_detection_job(**kwargs)

Stops a protected health information (PHI) detection job in progress.

See also: AWS API Documentation

Request Syntax

response = client.stop_phi_detection_job(
    JobId='string'
)
Parameters
JobId (string) --

[REQUIRED]

The identifier of the PHI detection job to stop.

Return type
dict
Returns
Response Syntax
{
    'JobId': 'string'
}

Response Structure

  • (dict) --
    • JobId (string) --

      The identifier of the PHI detection job that was stopped.

Exceptions

  • ComprehendMedical.Client.exceptions.InvalidRequestException
  • ComprehendMedical.Client.exceptions.ResourceNotFoundException
  • ComprehendMedical.Client.exceptions.InternalServerException