ListWhatIfAnalyses
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.
Request Syntax
{
"Filters": [
{
"Condition": "string
",
"Key": "string
",
"Value": "string
"
}
],
"MaxResults": number
,
"NextToken": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
- Filters
-
An array of filters. For each filter, you provide a condition and a match statement. The condition is either
IS
orIS_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 areIS
andIS_NOT
. To include the what-if analysis jobs that match the statement, specifyIS
. To exclude matching what-if analysis jobs, specifyIS_NOT
. -
Key
- The name of the parameter to filter on. Valid values areWhatIfAnalysisArn
andStatus
. -
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:<acct-id>:forecast/electricityWhatIf" } ]
Type: Array of Filter objects
Required: No
-
- MaxResults
-
The number of items to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern:
.+
Required: No
Response Syntax
{
"NextToken": "string",
"WhatIfAnalyses": [
{
"CreationTime": number,
"ForecastArn": "string",
"LastModificationTime": number,
"Message": "string",
"Status": "string",
"WhatIfAnalysisArn": "string",
"WhatIfAnalysisName": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern:
.+
- WhatIfAnalyses
-
An array of
WhatIfAnalysisSummary
objects that describe the matched analyses.Type: Array of WhatIfAnalysisSummary objects
Errors
- InvalidInputException
-
We can't process the request because it includes an invalid value or a value that exceeds the valid range.
HTTP Status Code: 400
- InvalidNextTokenException
-
The token is not valid. Tokens expire after 24 hours.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: