describeWhatIfAnalysis method

Future<DescribeWhatIfAnalysisResponse> describeWhatIfAnalysis({
  1. required String whatIfAnalysisArn,
})

Describes the what-if analysis created using the CreateWhatIfAnalysis operation.

In addition to listing the properties provided in the CreateWhatIfAnalysis 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 whatIfAnalysisArn : The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.

Implementation

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

  return DescribeWhatIfAnalysisResponse.fromJson(jsonResponse.body);
}