listSimulationJobBatches method

Future<ListSimulationJobBatchesResponse> listSimulationJobBatches({ List<Filter>? filters, int? maxResults, String? nextToken, })

Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.

May throw InvalidParameterException. May throw InternalServerException.

Parameter filters : Optional filters to limit results.

Parameter 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.

Parameter 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.

Implementation

Future<ListSimulationJobBatchesResponse> listSimulationJobBatches({
  List<Filter>? filters,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateStringLength(
    'nextToken',
    nextToken,
    1,
    2048,
  );
  final $payload = <String, dynamic>{
    if (filters != null) 'filters': filters,
    if (maxResults != null) 'maxResults': maxResults,
    if (nextToken != null) 'nextToken': nextToken,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/listSimulationJobBatches',
    exceptionFnMap: _exceptionFns,
  );
  return ListSimulationJobBatchesResponse.fromJson(response);
}