IoTFleetWise / Client / list_vehicles_in_fleet
list_vehicles_in_fleet#
- IoTFleetWise.Client.list_vehicles_in_fleet(**kwargs)#
Retrieves a list of summaries of all vehicles associated with a fleet.
Note
This API operation uses pagination. Specify the
nextToken
parameter in the request to return more results.See also: AWS API Documentation
Request Syntax
response = client.list_vehicles_in_fleet( fleetId='string', nextToken='string', maxResults=123 )
- Parameters:
fleetId (string) –
[REQUIRED]
The ID of a fleet.
nextToken (string) –
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.maxResults (integer) – The maximum number of items to return, between 1 and 100, inclusive.
- Return type:
dict
- Returns:
Response Syntax
{ 'vehicles': [ 'string', ], 'nextToken': 'string' }
Response Structure
(dict) –
vehicles (list) –
A list of vehicles associated with the fleet.
(string) –
nextToken (string) –
The token to retrieve the next set of results, or
null
if there are no more results.
Exceptions
IoTFleetWise.Client.exceptions.InternalServerException
IoTFleetWise.Client.exceptions.ResourceNotFoundException
IoTFleetWise.Client.exceptions.ThrottlingException
IoTFleetWise.Client.exceptions.ValidationException
IoTFleetWise.Client.exceptions.AccessDeniedException