describePHIDetectionJob method

Future<DescribePHIDetectionJobResponse> describePHIDetectionJob({
  1. required String jobId,
})

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

May throw InvalidRequestException. May throw TooManyRequestsException. May throw ResourceNotFoundException. May throw InternalServerException.

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

Implementation

Future<DescribePHIDetectionJobResponse> describePHIDetectionJob({
  required String jobId,
}) async {
  ArgumentError.checkNotNull(jobId, 'jobId');
  _s.validateStringLength(
    'jobId',
    jobId,
    1,
    32,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'ComprehendMedical_20181030.DescribePHIDetectionJob'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'JobId': jobId,
    },
  );

  return DescribePHIDetectionJobResponse.fromJson(jsonResponse.body);
}