describePredictor method

Future<DescribePredictorResponse> describePredictor({
  1. required String predictorArn,
})

Describes a predictor created using the CreatePredictor operation.

In addition to listing the properties provided in the CreatePredictor request, this operation lists the following properties:

  • DatasetImportJobArns - The dataset import jobs used to import training data.
  • AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.
  • CreationTime
  • LastModificationTime
  • Status
  • Message - If an error occurred, information about the error.

May throw InvalidInputException. May throw ResourceNotFoundException.

Parameter predictorArn : The Amazon Resource Name (ARN) of the predictor that you want information about.

Implementation

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

  return DescribePredictorResponse.fromJson(jsonResponse.body);
}