| 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.ListForecastExportJobs
Description
Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.
This operation returns paginated results.
Synopsis
- data ListForecastExportJobs = ListForecastExportJobs' {}
- newListForecastExportJobs :: ListForecastExportJobs
- listForecastExportJobs_filters :: Lens' ListForecastExportJobs (Maybe [Filter])
- listForecastExportJobs_maxResults :: Lens' ListForecastExportJobs (Maybe Natural)
- listForecastExportJobs_nextToken :: Lens' ListForecastExportJobs (Maybe Text)
- data ListForecastExportJobsResponse = ListForecastExportJobsResponse' {}
- newListForecastExportJobsResponse :: Int -> ListForecastExportJobsResponse
- listForecastExportJobsResponse_forecastExportJobs :: Lens' ListForecastExportJobsResponse (Maybe [ForecastExportJobSummary])
- listForecastExportJobsResponse_nextToken :: Lens' ListForecastExportJobsResponse (Maybe Text)
- listForecastExportJobsResponse_httpStatus :: Lens' ListForecastExportJobsResponse Int
Creating a Request
data ListForecastExportJobs Source #
See: newListForecastExportJobs smart constructor.
Constructors
| ListForecastExportJobs' | |
Fields
| |
Instances
newListForecastExportJobs :: ListForecastExportJobs Source #
Create a value of ListForecastExportJobs 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:ListForecastExportJobs', listForecastExportJobs_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 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 areForecastArnandStatus.Value- The value to match.
For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]$sel:maxResults:ListForecastExportJobs', listForecastExportJobs_maxResults - The number of items to return in the response.
ListForecastExportJobs, listForecastExportJobs_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
listForecastExportJobs_filters :: Lens' ListForecastExportJobs (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 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 areForecastArnandStatus.Value- The value to match.
For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]listForecastExportJobs_maxResults :: Lens' ListForecastExportJobs (Maybe Natural) Source #
The number of items to return in the response.
listForecastExportJobs_nextToken :: Lens' ListForecastExportJobs (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 ListForecastExportJobsResponse Source #
See: newListForecastExportJobsResponse smart constructor.
Constructors
| ListForecastExportJobsResponse' | |
Fields
| |
Instances
newListForecastExportJobsResponse Source #
Create a value of ListForecastExportJobsResponse 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:forecastExportJobs:ListForecastExportJobsResponse', listForecastExportJobsResponse_forecastExportJobs - An array of objects that summarize each export job's properties.
ListForecastExportJobs, listForecastExportJobsResponse_nextToken - If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:httpStatus:ListForecastExportJobsResponse', listForecastExportJobsResponse_httpStatus - The response's http status code.
Response Lenses
listForecastExportJobsResponse_forecastExportJobs :: Lens' ListForecastExportJobsResponse (Maybe [ForecastExportJobSummary]) Source #
An array of objects that summarize each export job's properties.
listForecastExportJobsResponse_nextToken :: Lens' ListForecastExportJobsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listForecastExportJobsResponse_httpStatus :: Lens' ListForecastExportJobsResponse Int Source #
The response's http status code.