ListWhatIfAnalysesCommand

Suggest an Edit

Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the DescribeWhatIfAnalysis operation.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ForecastClient, ListWhatIfAnalysesCommand } from "@aws-sdk/client-forecast"; // ES Modules import
// const { ForecastClient, ListWhatIfAnalysesCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
const client = new ForecastClient(config);
const input = { // ListWhatIfAnalysesRequest
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  Filters: [ // Filters
    { // Filter
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
      Condition: "IS" || "IS_NOT", // required
    },
  ],
};
const command = new ListWhatIfAnalysesCommand(input);
const response = await client.send(command);
// { // ListWhatIfAnalysesResponse
//   WhatIfAnalyses: [ // WhatIfAnalyses
//     { // WhatIfAnalysisSummary
//       WhatIfAnalysisArn: "STRING_VALUE",
//       WhatIfAnalysisName: "STRING_VALUE",
//       ForecastArn: "STRING_VALUE",
//       Status: "STRING_VALUE",
//       Message: "STRING_VALUE",
//       CreationTime: new Date("TIMESTAMP"),
//       LastModificationTime: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListWhatIfAnalysesCommand Input

See ListWhatIfAnalysesCommandInput for more details

Parameter
Type
Description
Filters
Filter[] | undefined

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the what-if analysis jobs that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the what-if analysis jobs that match the statement, specify IS. To exclude matching what-if analysis jobs, specify IS_NOT.

  • Key - The name of the parameter to filter on. Valid values are WhatIfAnalysisArn and Status.

  • Value - The value to match.

For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:

"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2::forecast/electricityWhatIf" } ]

MaxResults
number | undefined

The number of items to return in the response.

NextToken
string | undefined

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

ListWhatIfAnalysesCommand Output

See ListWhatIfAnalysesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.

WhatIfAnalyses
WhatIfAnalysisSummary[] | undefined

An array of WhatIfAnalysisSummary objects that describe the matched analyses.

Throws

Name
Fault
Details
InvalidInputException
client

We can't process the request because it includes an invalid value or a value that exceeds the valid range.

InvalidNextTokenException
client

The token is not valid. Tokens expire after 24 hours.

ForecastServiceException
Base exception class for all service exceptions from Forecast service.