| 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.ListDatasetImportJobs
Description
Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, 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 ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.
This operation returns paginated results.
Synopsis
- data ListDatasetImportJobs = ListDatasetImportJobs' {}
- newListDatasetImportJobs :: ListDatasetImportJobs
- listDatasetImportJobs_filters :: Lens' ListDatasetImportJobs (Maybe [Filter])
- listDatasetImportJobs_maxResults :: Lens' ListDatasetImportJobs (Maybe Natural)
- listDatasetImportJobs_nextToken :: Lens' ListDatasetImportJobs (Maybe Text)
- data ListDatasetImportJobsResponse = ListDatasetImportJobsResponse' {}
- newListDatasetImportJobsResponse :: Int -> ListDatasetImportJobsResponse
- listDatasetImportJobsResponse_datasetImportJobs :: Lens' ListDatasetImportJobsResponse (Maybe [DatasetImportJobSummary])
- listDatasetImportJobsResponse_nextToken :: Lens' ListDatasetImportJobsResponse (Maybe Text)
- listDatasetImportJobsResponse_httpStatus :: Lens' ListDatasetImportJobsResponse Int
Creating a Request
data ListDatasetImportJobs Source #
See: newListDatasetImportJobs smart constructor.
Constructors
| ListDatasetImportJobs' | |
Fields
| |
Instances
newListDatasetImportJobs :: ListDatasetImportJobs Source #
Create a value of ListDatasetImportJobs 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:ListDatasetImportJobs', listDatasetImportJobs_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 datasets 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 datasets that match the statement, specifyIS. To exclude matching datasets, specifyIS_NOT.Key- The name of the parameter to filter on. Valid values areDatasetArnandStatus.Value- The value to match.
For example, to list all dataset import jobs whose status is ACTIVE, you specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]$sel:maxResults:ListDatasetImportJobs', listDatasetImportJobs_maxResults - The number of items to return in the response.
ListDatasetImportJobs, listDatasetImportJobs_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
listDatasetImportJobs_filters :: Lens' ListDatasetImportJobs (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 datasets 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 datasets that match the statement, specifyIS. To exclude matching datasets, specifyIS_NOT.Key- The name of the parameter to filter on. Valid values areDatasetArnandStatus.Value- The value to match.
For example, to list all dataset import jobs whose status is ACTIVE, you specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]listDatasetImportJobs_maxResults :: Lens' ListDatasetImportJobs (Maybe Natural) Source #
The number of items to return in the response.
listDatasetImportJobs_nextToken :: Lens' ListDatasetImportJobs (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 ListDatasetImportJobsResponse Source #
See: newListDatasetImportJobsResponse smart constructor.
Constructors
| ListDatasetImportJobsResponse' | |
Fields
| |
Instances
newListDatasetImportJobsResponse Source #
Create a value of ListDatasetImportJobsResponse 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:datasetImportJobs:ListDatasetImportJobsResponse', listDatasetImportJobsResponse_datasetImportJobs - An array of objects that summarize each dataset import job's
properties.
ListDatasetImportJobs, listDatasetImportJobsResponse_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:ListDatasetImportJobsResponse', listDatasetImportJobsResponse_httpStatus - The response's http status code.
Response Lenses
listDatasetImportJobsResponse_datasetImportJobs :: Lens' ListDatasetImportJobsResponse (Maybe [DatasetImportJobSummary]) Source #
An array of objects that summarize each dataset import job's properties.
listDatasetImportJobsResponse_nextToken :: Lens' ListDatasetImportJobsResponse (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.
listDatasetImportJobsResponse_httpStatus :: Lens' ListDatasetImportJobsResponse Int Source #
The response's http status code.