| 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.RobOMaker.ListSimulationJobBatches
Description
Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.
This operation returns paginated results.
Synopsis
- data ListSimulationJobBatches = ListSimulationJobBatches' {}
- newListSimulationJobBatches :: ListSimulationJobBatches
- listSimulationJobBatches_filters :: Lens' ListSimulationJobBatches (Maybe (NonEmpty Filter))
- listSimulationJobBatches_maxResults :: Lens' ListSimulationJobBatches (Maybe Int)
- listSimulationJobBatches_nextToken :: Lens' ListSimulationJobBatches (Maybe Text)
- data ListSimulationJobBatchesResponse = ListSimulationJobBatchesResponse' {}
- newListSimulationJobBatchesResponse :: Int -> ListSimulationJobBatchesResponse
- listSimulationJobBatchesResponse_nextToken :: Lens' ListSimulationJobBatchesResponse (Maybe Text)
- listSimulationJobBatchesResponse_simulationJobBatchSummaries :: Lens' ListSimulationJobBatchesResponse (Maybe [SimulationJobBatchSummary])
- listSimulationJobBatchesResponse_httpStatus :: Lens' ListSimulationJobBatchesResponse Int
Creating a Request
data ListSimulationJobBatches Source #
See: newListSimulationJobBatches smart constructor.
Constructors
| ListSimulationJobBatches' | |
Fields
| |
Instances
newListSimulationJobBatches :: ListSimulationJobBatches Source #
Create a value of ListSimulationJobBatches 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:ListSimulationJobBatches', listSimulationJobBatches_filters - Optional filters to limit results.
$sel:maxResults:ListSimulationJobBatches', listSimulationJobBatches_maxResults - When this parameter is used, ListSimulationJobBatches 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 ListSimulationJobBatches request with the returned
nextToken value.
ListSimulationJobBatches, listSimulationJobBatches_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
ListSimulationJobBatches 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.
Request Lenses
listSimulationJobBatches_filters :: Lens' ListSimulationJobBatches (Maybe (NonEmpty Filter)) Source #
Optional filters to limit results.
listSimulationJobBatches_maxResults :: Lens' ListSimulationJobBatches (Maybe Int) Source #
When this parameter is used, ListSimulationJobBatches 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 ListSimulationJobBatches request with the returned
nextToken value.
listSimulationJobBatches_nextToken :: Lens' ListSimulationJobBatches (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
ListSimulationJobBatches 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.
Destructuring the Response
data ListSimulationJobBatchesResponse Source #
See: newListSimulationJobBatchesResponse smart constructor.
Constructors
| ListSimulationJobBatchesResponse' | |
Fields
| |
Instances
newListSimulationJobBatchesResponse Source #
Create a value of ListSimulationJobBatchesResponse 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:
ListSimulationJobBatches, listSimulationJobBatchesResponse_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
ListSimulationJobBatches 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:simulationJobBatchSummaries:ListSimulationJobBatchesResponse', listSimulationJobBatchesResponse_simulationJobBatchSummaries - A list of simulation job batch summaries.
$sel:httpStatus:ListSimulationJobBatchesResponse', listSimulationJobBatchesResponse_httpStatus - The response's http status code.
Response Lenses
listSimulationJobBatchesResponse_nextToken :: Lens' ListSimulationJobBatchesResponse (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
ListSimulationJobBatches 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.
listSimulationJobBatchesResponse_simulationJobBatchSummaries :: Lens' ListSimulationJobBatchesResponse (Maybe [SimulationJobBatchSummary]) Source #
A list of simulation job batch summaries.
listSimulationJobBatchesResponse_httpStatus :: Lens' ListSimulationJobBatchesResponse Int Source #
The response's http status code.