describeBatchInferenceJob method

Future<DescribeBatchInferenceJobResponse> describeBatchInferenceJob({ required String batchInferenceJobArn, })

Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.

May throw InvalidInputException. May throw ResourceNotFoundException.

Parameter batchInferenceJobArn : The ARN of the batch inference job to describe.

Implementation

Future<DescribeBatchInferenceJobResponse> describeBatchInferenceJob({
  required String batchInferenceJobArn,
}) async {
  ArgumentError.checkNotNull(batchInferenceJobArn, 'batchInferenceJobArn');
  _s.validateStringLength(
    'batchInferenceJobArn',
    batchInferenceJobArn,
    0,
    256,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonPersonalize.DescribeBatchInferenceJob'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'batchInferenceJobArn': batchInferenceJobArn,
    },
  );

  return DescribeBatchInferenceJobResponse.fromJson(jsonResponse.body);
}