listVehiclesInFleet method

Future<ListVehiclesInFleetResponse> listVehiclesInFleet({
  1. required String fleetId,
  2. int? maxResults,
  3. String? nextToken,
})

Retrieves a list of summaries of all vehicles associated with a fleet.

May throw AccessDeniedException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter fleetId : The ID of a fleet.

Parameter maxResults : The maximum number of items to return, between 1 and 100, inclusive.

Parameter nextToken : A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Implementation

Future<ListVehiclesInFleetResponse> listVehiclesInFleet({
  required String fleetId,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'IoTAutobahnControlPlane.ListVehiclesInFleet'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'fleetId': fleetId,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
    },
  );

  return ListVehiclesInFleetResponse.fromJson(jsonResponse.body);
}