Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
This operation returns paginated results.
Synopsis
- data ListWhatIfAnalyses = ListWhatIfAnalyses' {}
- newListWhatIfAnalyses :: ListWhatIfAnalyses
- listWhatIfAnalyses_filters :: Lens' ListWhatIfAnalyses (Maybe [Filter])
- listWhatIfAnalyses_maxResults :: Lens' ListWhatIfAnalyses (Maybe Natural)
- listWhatIfAnalyses_nextToken :: Lens' ListWhatIfAnalyses (Maybe Text)
- data ListWhatIfAnalysesResponse = ListWhatIfAnalysesResponse' {}
- newListWhatIfAnalysesResponse :: Int -> ListWhatIfAnalysesResponse
- listWhatIfAnalysesResponse_nextToken :: Lens' ListWhatIfAnalysesResponse (Maybe Text)
- listWhatIfAnalysesResponse_whatIfAnalyses :: Lens' ListWhatIfAnalysesResponse (Maybe [WhatIfAnalysisSummary])
- listWhatIfAnalysesResponse_httpStatus :: Lens' ListWhatIfAnalysesResponse Int
Creating a Request
data ListWhatIfAnalyses Source #
See: newListWhatIfAnalyses
smart constructor.
ListWhatIfAnalyses' | |
|
Instances
newListWhatIfAnalyses :: ListWhatIfAnalyses Source #
Create a value of ListWhatIfAnalyses
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListWhatIfAnalyses'
, listWhatIfAnalyses_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 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" } ]
$sel:maxResults:ListWhatIfAnalyses'
, listWhatIfAnalyses_maxResults
- The number of items to return in the response.
ListWhatIfAnalyses
, listWhatIfAnalyses_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.
Request Lenses
listWhatIfAnalyses_filters :: Lens' ListWhatIfAnalyses (Maybe [Filter]) Source #
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 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" } ]
listWhatIfAnalyses_maxResults :: Lens' ListWhatIfAnalyses (Maybe Natural) Source #
The number of items to return in the response.
listWhatIfAnalyses_nextToken :: Lens' ListWhatIfAnalyses (Maybe Text) Source #
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.
Destructuring the Response
data ListWhatIfAnalysesResponse Source #
See: newListWhatIfAnalysesResponse
smart constructor.
ListWhatIfAnalysesResponse' | |
|
Instances
newListWhatIfAnalysesResponse Source #
Create a value of ListWhatIfAnalysesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWhatIfAnalyses
, listWhatIfAnalysesResponse_nextToken
- If the response is truncated, Forecast returns this token. To retrieve
the next set of results, use the token in the next request.
$sel:whatIfAnalyses:ListWhatIfAnalysesResponse'
, listWhatIfAnalysesResponse_whatIfAnalyses
- An array of WhatIfAnalysisSummary
objects that describe the matched
analyses.
$sel:httpStatus:ListWhatIfAnalysesResponse'
, listWhatIfAnalysesResponse_httpStatus
- The response's http status code.
Response Lenses
listWhatIfAnalysesResponse_nextToken :: Lens' ListWhatIfAnalysesResponse (Maybe Text) Source #
If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listWhatIfAnalysesResponse_whatIfAnalyses :: Lens' ListWhatIfAnalysesResponse (Maybe [WhatIfAnalysisSummary]) Source #
An array of WhatIfAnalysisSummary
objects that describe the matched
analyses.
listWhatIfAnalysesResponse_httpStatus :: Lens' ListWhatIfAnalysesResponse Int Source #
The response's http status code.