describeWhatIfForecast method

Future<DescribeWhatIfForecastResponse> describeWhatIfForecast({
  1. required String whatIfForecastArn,
})

Describes the what-if forecast created using the CreateWhatIfForecast operation.

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

  • CreationTime
  • LastModificationTime
  • Message - If an error occurred, information about the error.
  • Status

May throw InvalidInputException. May throw ResourceNotFoundException.

Parameter whatIfForecastArn : The Amazon Resource Name (ARN) of the what-if forecast that you are interested in.

Implementation

Future<DescribeWhatIfForecastResponse> describeWhatIfForecast({
  required String whatIfForecastArn,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonForecast.DescribeWhatIfForecast'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'WhatIfForecastArn': whatIfForecastArn,
    },
  );

  return DescribeWhatIfForecastResponse.fromJson(jsonResponse.body);
}