describePiiEntitiesDetectionJob method

Future<DescribePiiEntitiesDetectionJobResponse> describePiiEntitiesDetectionJob({ required String jobId, })

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

May throw InvalidRequestException. May throw JobNotFoundException. May throw TooManyRequestsException. May throw InternalServerException.

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

Implementation

Future<DescribePiiEntitiesDetectionJobResponse>
    describePiiEntitiesDetectionJob({
  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': 'Comprehend_20171127.DescribePiiEntitiesDetectionJob'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'JobId': jobId,
    },
  );

  return DescribePiiEntitiesDetectionJobResponse.fromJson(jsonResponse.body);
}