| 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 |
Amazonka.Forecast.ListWhatIfForecastExports
Description
Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For each what-if forecast export, 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 export ARN with the DescribeWhatIfForecastExport operation.
This operation returns paginated results.
Synopsis
- data ListWhatIfForecastExports = ListWhatIfForecastExports' {}
- newListWhatIfForecastExports :: ListWhatIfForecastExports
- listWhatIfForecastExports_filters :: Lens' ListWhatIfForecastExports (Maybe [Filter])
- listWhatIfForecastExports_maxResults :: Lens' ListWhatIfForecastExports (Maybe Natural)
- listWhatIfForecastExports_nextToken :: Lens' ListWhatIfForecastExports (Maybe Text)
- data ListWhatIfForecastExportsResponse = ListWhatIfForecastExportsResponse' {}
- newListWhatIfForecastExportsResponse :: Int -> ListWhatIfForecastExportsResponse
- listWhatIfForecastExportsResponse_nextToken :: Lens' ListWhatIfForecastExportsResponse (Maybe Text)
- listWhatIfForecastExportsResponse_whatIfForecastExports :: Lens' ListWhatIfForecastExportsResponse (Maybe [WhatIfForecastExportSummary])
- listWhatIfForecastExportsResponse_httpStatus :: Lens' ListWhatIfForecastExportsResponse Int
Creating a Request
data ListWhatIfForecastExports Source #
See: newListWhatIfForecastExports smart constructor.
Constructors
| ListWhatIfForecastExports' | |
Fields
| |
Instances
newListWhatIfForecastExports :: ListWhatIfForecastExports Source #
Create a value of ListWhatIfForecastExports 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:ListWhatIfForecastExports', listWhatIfForecastExports_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 areISandIS_NOT. To include the forecast export jobs that match the statement, specifyIS. To exclude matching forecast export jobs, specifyIS_NOT.Key- The name of the parameter to filter on. Valid values areWhatIfForecastExportArnandStatus.Value- The value to match.
For example, to list all jobs that export a forecast named electricityWIFExport, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport" } ]$sel:maxResults:ListWhatIfForecastExports', listWhatIfForecastExports_maxResults - The number of items to return in the response.
ListWhatIfForecastExports, listWhatIfForecastExports_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
listWhatIfForecastExports_filters :: Lens' ListWhatIfForecastExports (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 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 areISandIS_NOT. To include the forecast export jobs that match the statement, specifyIS. To exclude matching forecast export jobs, specifyIS_NOT.Key- The name of the parameter to filter on. Valid values areWhatIfForecastExportArnandStatus.Value- The value to match.
For example, to list all jobs that export a forecast named electricityWIFExport, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport" } ]listWhatIfForecastExports_maxResults :: Lens' ListWhatIfForecastExports (Maybe Natural) Source #
The number of items to return in the response.
listWhatIfForecastExports_nextToken :: Lens' ListWhatIfForecastExports (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 ListWhatIfForecastExportsResponse Source #
See: newListWhatIfForecastExportsResponse smart constructor.
Constructors
| ListWhatIfForecastExportsResponse' | |
Fields
| |
Instances
newListWhatIfForecastExportsResponse Source #
Arguments
| :: Int | |
| -> ListWhatIfForecastExportsResponse |
Create a value of ListWhatIfForecastExportsResponse 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:
ListWhatIfForecastExports, listWhatIfForecastExportsResponse_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:whatIfForecastExports:ListWhatIfForecastExportsResponse', listWhatIfForecastExportsResponse_whatIfForecastExports - An array of WhatIfForecastExports objects that describe the matched
forecast exports.
$sel:httpStatus:ListWhatIfForecastExportsResponse', listWhatIfForecastExportsResponse_httpStatus - The response's http status code.
Response Lenses
listWhatIfForecastExportsResponse_nextToken :: Lens' ListWhatIfForecastExportsResponse (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.
listWhatIfForecastExportsResponse_whatIfForecastExports :: Lens' ListWhatIfForecastExportsResponse (Maybe [WhatIfForecastExportSummary]) Source #
An array of WhatIfForecastExports objects that describe the matched
forecast exports.
listWhatIfForecastExportsResponse_httpStatus :: Lens' ListWhatIfForecastExportsResponse Int Source #
The response's http status code.