Skip to content

/AWS1/CL_FCS=>LISTWHATIFFORECASTS()

About ListWhatIfForecasts

Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if forecast, 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 forecast ARN with the DescribeWhatIfForecast operation.

Method Signature

IMPORTING

Optional arguments:

IV_NEXTTOKEN TYPE /AWS1/FCSNEXTTOKEN /AWS1/FCSNEXTTOKEN

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.

IV_MAXRESULTS TYPE /AWS1/FCSMAXRESULTS /AWS1/FCSMAXRESULTS

The number of items to return in the response.

IT_FILTERS TYPE /AWS1/CL_FCSFILTER=>TT_FILTERS TT_FILTERS

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 forecast export 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 forecast export jobs that match the statement, specify IS. To exclude matching forecast export jobs, specify IS_NOT.

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

  • Value - The value to match.

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

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_FCSLISTWHATIFFCSRSP /AWS1/CL_FCSLISTWHATIFFCSRSP