listVehicles method
Retrieves a list of summaries of created vehicles.
May throw AccessDeniedException.
May throw InternalServerException.
May throw ThrottlingException.
May throw ValidationException.
Parameter attributeNames :
The fully qualified names of the attributes. You can use this optional
parameter to list the vehicles containing all the attributes in the
request. For example, attributeNames could be
"Vehicle.Body.Engine.Type, Vehicle.Color" and the
corresponding attributeValues could be "1.3 L R2,
Blue" . In this case, the API will filter vehicles with an
attribute name Vehicle.Body.Engine.Type that contains a value
of 1.3 L R2 AND an attribute name Vehicle.Color
that contains a value of "Blue". A request must contain
unique values for the attributeNames filter and the matching
number of attributeValues filters to return the subset of
vehicles that match the attributes filter condition.
Parameter attributeValues :
Static information about a vehicle attribute value in string format. You
can use this optional parameter in conjunction with
attributeNames to list the vehicles containing all the
attributeValues corresponding to the
attributeNames filter. For example,
attributeValues could be "1.3 L R2, Blue" and
the corresponding attributeNames filter could be
"Vehicle.Body.Engine.Type, Vehicle.Color". In this case, the
API will filter vehicles with attribute name
Vehicle.Body.Engine.Type that contains a value of 1.3 L
R2 AND an attribute name Vehicle.Color that contains a
value of "Blue". A request must contain unique values for the
attributeNames filter and the matching number of
attributeValues filter to return the subset of vehicles that
match the attributes filter condition.
Parameter listResponseScope :
When you set the listResponseScope parameter to
METADATA_ONLY, the list response includes: vehicle name,
Amazon Resource Name (ARN), creation time, and last modification time.
Parameter maxResults :
The maximum number of items to return, between 1 and 100, inclusive.
Parameter modelManifestArn :
The Amazon Resource Name (ARN) of a vehicle model (model manifest). You
can use this optional parameter to list only the vehicles created from a
certain vehicle model.
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<ListVehiclesResponse> listVehicles({
List<String>? attributeNames,
List<String>? attributeValues,
ListResponseScope? listResponseScope,
int? maxResults,
String? modelManifestArn,
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.ListVehicles'
};
final jsonResponse = await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
// TODO queryParams
headers: headers,
payload: {
if (attributeNames != null) 'attributeNames': attributeNames,
if (attributeValues != null) 'attributeValues': attributeValues,
if (listResponseScope != null)
'listResponseScope': listResponseScope.value,
if (maxResults != null) 'maxResults': maxResults,
if (modelManifestArn != null) 'modelManifestArn': modelManifestArn,
if (nextToken != null) 'nextToken': nextToken,
},
);
return ListVehiclesResponse.fromJson(jsonResponse.body);
}