listRobotApplications method

Future<ListRobotApplicationsResponse> listRobotApplications({ List<Filter>? filters, int? maxResults, String? nextToken, String? versionQualifier, })

Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.

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

Parameter filters : Optional filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

Parameter maxResults : When this parameter is used, ListRobotApplications 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 ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 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 ListRobotApplications 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.

Parameter versionQualifier : The version qualifier of the robot application.

Implementation

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