aws_sdk_iotfleetwise/client/
get_vehicle_status.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetVehicleStatus`](crate::operation::get_vehicle_status::builders::GetVehicleStatusFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_vehicle_status::builders::GetVehicleStatusFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_vehicle_status::builders::GetVehicleStatusFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_vehicle_status::builders::GetVehicleStatusFluentBuilder::set_next_token):<br>required: **false**<br><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><br>
    ///   - [`max_results(i32)`](crate::operation::get_vehicle_status::builders::GetVehicleStatusFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_vehicle_status::builders::GetVehicleStatusFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return, between 1 and 100, inclusive.</p><br>
    ///   - [`vehicle_name(impl Into<String>)`](crate::operation::get_vehicle_status::builders::GetVehicleStatusFluentBuilder::vehicle_name) / [`set_vehicle_name(Option<String>)`](crate::operation::get_vehicle_status::builders::GetVehicleStatusFluentBuilder::set_vehicle_name):<br>required: **true**<br><p>The ID of the vehicle to retrieve information about.</p><br>
    /// - On success, responds with [`GetVehicleStatusOutput`](crate::operation::get_vehicle_status::GetVehicleStatusOutput) with field(s):
    ///   - [`campaigns(Option<Vec::<VehicleStatus>>)`](crate::operation::get_vehicle_status::GetVehicleStatusOutput::campaigns): <p>Lists information about the state of the vehicle with deployed campaigns.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_vehicle_status::GetVehicleStatusOutput::next_token): <p>The token to retrieve the next set of results, or <code>null</code> if there are no more results.</p>
    /// - On failure, responds with [`SdkError<GetVehicleStatusError>`](crate::operation::get_vehicle_status::GetVehicleStatusError)
    pub fn get_vehicle_status(&self) -> crate::operation::get_vehicle_status::builders::GetVehicleStatusFluentBuilder {
        crate::operation::get_vehicle_status::builders::GetVehicleStatusFluentBuilder::new(self.handle.clone())
    }
}