listSimulationJobs method

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

Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.

May throw InvalidParameterException. May throw InternalServerException. May throw ThrottlingException.

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

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

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

Implementation

Future<ListSimulationJobsResponse> listSimulationJobs({
  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: '/listSimulationJobs',
    exceptionFnMap: _exceptionFns,
  );
  return ListSimulationJobsResponse.fromJson(response);
}