Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
This operation returns paginated results.
Synopsis
- data ListSimulationJobs = ListSimulationJobs' {}
- newListSimulationJobs :: ListSimulationJobs
- listSimulationJobs_filters :: Lens' ListSimulationJobs (Maybe (NonEmpty Filter))
- listSimulationJobs_nextToken :: Lens' ListSimulationJobs (Maybe Text)
- listSimulationJobs_maxResults :: Lens' ListSimulationJobs (Maybe Int)
- data ListSimulationJobsResponse = ListSimulationJobsResponse' {}
- newListSimulationJobsResponse :: Int -> ListSimulationJobsResponse
- listSimulationJobsResponse_nextToken :: Lens' ListSimulationJobsResponse (Maybe Text)
- listSimulationJobsResponse_httpStatus :: Lens' ListSimulationJobsResponse Int
- listSimulationJobsResponse_simulationJobSummaries :: Lens' ListSimulationJobsResponse [SimulationJobSummary]
Creating a Request
data ListSimulationJobs Source #
See: newListSimulationJobs
smart constructor.
ListSimulationJobs' | |
|
Instances
newListSimulationJobs :: ListSimulationJobs Source #
Create a value of ListSimulationJobs
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:ListSimulationJobs'
, listSimulationJobs_filters
- Optional filters to limit results.
The filter names status
and simulationApplicationName
and
robotApplicationName
are supported. When filtering, you must use the
complete value of the filtered item. You can use up to three filters,
but they must be for the same named item. For example, if you are
looking for items with the status Preparing
or the status Running
.
$sel:nextToken:ListSimulationJobs'
, listSimulationJobs_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call ListSimulationJobs
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
$sel:maxResults:ListSimulationJobs'
, listSimulationJobs_maxResults
- When this parameter is used, ListSimulationJobs
only returns
maxResults
results in a single page along with a nextToken
response
element. The remaining results of the initial request can be seen by
sending another ListSimulationJobs
request with the returned
nextToken
value. This value can be between 1 and 1000. If this
parameter is not used, then ListSimulationJobs
returns up to 1000
results and a nextToken
value if applicable.
Request Lenses
listSimulationJobs_filters :: Lens' ListSimulationJobs (Maybe (NonEmpty Filter)) Source #
Optional filters to limit results.
The filter names status
and simulationApplicationName
and
robotApplicationName
are supported. When filtering, you must use the
complete value of the filtered item. You can use up to three filters,
but they must be for the same named item. For example, if you are
looking for items with the status Preparing
or the status Running
.
listSimulationJobs_nextToken :: Lens' ListSimulationJobs (Maybe Text) Source #
If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call ListSimulationJobs
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
listSimulationJobs_maxResults :: Lens' ListSimulationJobs (Maybe Int) Source #
When this parameter is used, ListSimulationJobs
only returns
maxResults
results in a single page along with a nextToken
response
element. The remaining results of the initial request can be seen by
sending another ListSimulationJobs
request with the returned
nextToken
value. This value can be between 1 and 1000. If this
parameter is not used, then ListSimulationJobs
returns up to 1000
results and a nextToken
value if applicable.
Destructuring the Response
data ListSimulationJobsResponse Source #
See: newListSimulationJobsResponse
smart constructor.
ListSimulationJobsResponse' | |
|
Instances
newListSimulationJobsResponse Source #
Create a value of ListSimulationJobsResponse
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:nextToken:ListSimulationJobs'
, listSimulationJobsResponse_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call ListSimulationJobs
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
$sel:httpStatus:ListSimulationJobsResponse'
, listSimulationJobsResponse_httpStatus
- The response's http status code.
$sel:simulationJobSummaries:ListSimulationJobsResponse'
, listSimulationJobsResponse_simulationJobSummaries
- A list of simulation job summaries that meet the criteria of the
request.
Response Lenses
listSimulationJobsResponse_nextToken :: Lens' ListSimulationJobsResponse (Maybe Text) Source #
If the previous paginated request did not return all of the remaining
results, the response object's nextToken
parameter value is set to a
token. To retrieve the next set of results, call ListSimulationJobs
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
listSimulationJobsResponse_httpStatus :: Lens' ListSimulationJobsResponse Int Source #
The response's http status code.
listSimulationJobsResponse_simulationJobSummaries :: Lens' ListSimulationJobsResponse [SimulationJobSummary] Source #
A list of simulation job summaries that meet the criteria of the request.