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 |
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
This operation returns paginated results.
Synopsis
- data ListEarthObservationJobs = ListEarthObservationJobs' {}
- newListEarthObservationJobs :: ListEarthObservationJobs
- listEarthObservationJobs_maxResults :: Lens' ListEarthObservationJobs (Maybe Natural)
- listEarthObservationJobs_nextToken :: Lens' ListEarthObservationJobs (Maybe Text)
- listEarthObservationJobs_sortBy :: Lens' ListEarthObservationJobs (Maybe Text)
- listEarthObservationJobs_sortOrder :: Lens' ListEarthObservationJobs (Maybe SortOrder)
- listEarthObservationJobs_statusEquals :: Lens' ListEarthObservationJobs (Maybe EarthObservationJobStatus)
- data ListEarthObservationJobsResponse = ListEarthObservationJobsResponse' {}
- newListEarthObservationJobsResponse :: Int -> ListEarthObservationJobsResponse
- listEarthObservationJobsResponse_nextToken :: Lens' ListEarthObservationJobsResponse (Maybe Text)
- listEarthObservationJobsResponse_httpStatus :: Lens' ListEarthObservationJobsResponse Int
- listEarthObservationJobsResponse_earthObservationJobSummaries :: Lens' ListEarthObservationJobsResponse [ListEarthObservationJobOutputConfig]
Creating a Request
data ListEarthObservationJobs Source #
See: newListEarthObservationJobs
smart constructor.
ListEarthObservationJobs' | |
|
Instances
newListEarthObservationJobs :: ListEarthObservationJobs Source #
Create a value of ListEarthObservationJobs
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:maxResults:ListEarthObservationJobs'
, listEarthObservationJobs_maxResults
- The total number of items to return.
ListEarthObservationJobs
, listEarthObservationJobs_nextToken
- If the previous response was truncated, you receive this token. Use it
in your next request to receive the next set of results.
$sel:sortBy:ListEarthObservationJobs'
, listEarthObservationJobs_sortBy
- The parameter by which to sort the results.
$sel:sortOrder:ListEarthObservationJobs'
, listEarthObservationJobs_sortOrder
- An optional value that specifies whether you want the results sorted in
Ascending
or Descending
order.
$sel:statusEquals:ListEarthObservationJobs'
, listEarthObservationJobs_statusEquals
- A filter that retrieves only jobs with a specific status.
Request Lenses
listEarthObservationJobs_maxResults :: Lens' ListEarthObservationJobs (Maybe Natural) Source #
The total number of items to return.
listEarthObservationJobs_nextToken :: Lens' ListEarthObservationJobs (Maybe Text) Source #
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
listEarthObservationJobs_sortBy :: Lens' ListEarthObservationJobs (Maybe Text) Source #
The parameter by which to sort the results.
listEarthObservationJobs_sortOrder :: Lens' ListEarthObservationJobs (Maybe SortOrder) Source #
An optional value that specifies whether you want the results sorted in
Ascending
or Descending
order.
listEarthObservationJobs_statusEquals :: Lens' ListEarthObservationJobs (Maybe EarthObservationJobStatus) Source #
A filter that retrieves only jobs with a specific status.
Destructuring the Response
data ListEarthObservationJobsResponse Source #
See: newListEarthObservationJobsResponse
smart constructor.
ListEarthObservationJobsResponse' | |
|
Instances
newListEarthObservationJobsResponse Source #
Create a value of ListEarthObservationJobsResponse
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:
ListEarthObservationJobs
, listEarthObservationJobsResponse_nextToken
- If the previous response was truncated, you receive this token. Use it
in your next request to receive the next set of results.
$sel:httpStatus:ListEarthObservationJobsResponse'
, listEarthObservationJobsResponse_httpStatus
- The response's http status code.
$sel:earthObservationJobSummaries:ListEarthObservationJobsResponse'
, listEarthObservationJobsResponse_earthObservationJobSummaries
- Contains summary information about the Earth Observation jobs.
Response Lenses
listEarthObservationJobsResponse_nextToken :: Lens' ListEarthObservationJobsResponse (Maybe Text) Source #
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
listEarthObservationJobsResponse_httpStatus :: Lens' ListEarthObservationJobsResponse Int Source #
The response's http status code.
listEarthObservationJobsResponse_earthObservationJobSummaries :: Lens' ListEarthObservationJobsResponse [ListEarthObservationJobOutputConfig] Source #
Contains summary information about the Earth Observation jobs.