Retrieves a list of IDs for all fleets that the vehicle is associated with.
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
Parameters:
-
vehicle_name
(vehicleName)
–
The ID of the vehicle to retrieve information about.
-
next_token
(Optional[nextToken], default:
None
)
–
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.
-
max_results
(Optional[maxResults], default:
None
)
–
The maximum number of items to return, between 1 and 100, inclusive.
Raises:
Source code in docs_src/capo_iotfleetwise/_services/io_t_fleet_wise.py
| def list_fleets_for_vehicle(
self,
vehicle_name: "capo_iotfleetwise.types.vehicle_name.vehicleName",
*,
config_overrides: Optional[IoTFleetWiseClientConfig] = None,
next_token: Optional["capo_iotfleetwise.types.next_token.nextToken"] = None,
max_results: Optional["capo_iotfleetwise.types.max_results.maxResults"] = None,
) -> "capo_iotfleetwise.types.list_fleets_for_vehicle_response.ListFleetsForVehicleResponse":
"""<p>Retrieves a list of IDs for all fleets that the vehicle is associated with.</p> <note> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p> </note>
Args:
vehicle_name: <p> The ID of the vehicle to retrieve information about. </p>
next_token: <p>A pagination token for the next set of results.</p> <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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. </p>
max_results: <p>The maximum number of items to return, between 1 and 100, inclusive.</p>
Raises:
capo_iotfleetwise.errors.internal_server_exception.InternalServerException: <p>The request couldn't be completed because the server temporarily failed.</p>
capo_iotfleetwise.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permission to perform this action.</p>
capo_iotfleetwise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource wasn't found.</p>
capo_iotfleetwise.errors.throttling_exception.ThrottlingException: <p>The request couldn't be completed due to throttling.</p>
capo_iotfleetwise.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
capo_iotfleetwise.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_iotfleetwise.types.list_fleets_for_vehicle_request.ListFleetsForVehicleRequest]",
) -> OperationResponse[
"capo_iotfleetwise.types.list_fleets_for_vehicle_response.ListFleetsForVehicleResponse"
]:
import capo_iotfleetwise._operations.io_t_autobahn_control_plane.list_fleets_for_vehicle
output, http_response = (
capo_iotfleetwise._operations.io_t_autobahn_control_plane.list_fleets_for_vehicle.list_fleets_for_vehicle(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListFleetsForVehicle")
)
input_: capo_iotfleetwise.types.list_fleets_for_vehicle_request.ListFleetsForVehicleRequest = {
"vehicle_name": vehicle_name
}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|