aws_sdk_iotfleetwise/client/create_vehicle.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateVehicle`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`vehicle_name(impl Into<String>)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::vehicle_name) / [`set_vehicle_name(Option<String>)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::set_vehicle_name):<br>required: **true**<br><p>The unique ID of the vehicle to create.</p><br>
7 /// - [`model_manifest_arn(impl Into<String>)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::model_manifest_arn) / [`set_model_manifest_arn(Option<String>)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::set_model_manifest_arn):<br>required: **true**<br><p>The Amazon Resource Name ARN of a vehicle model.</p><br>
8 /// - [`decoder_manifest_arn(impl Into<String>)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::decoder_manifest_arn) / [`set_decoder_manifest_arn(Option<String>)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::set_decoder_manifest_arn):<br>required: **true**<br><p>The ARN of a decoder manifest.</p><br>
9 /// - [`attributes(impl Into<String>, impl Into<String>)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::attributes) / [`set_attributes(Option<HashMap::<String, String>>)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::set_attributes):<br>required: **false**<br><p>Static information about a vehicle in a key-value pair. For example: <code>"engineType"</code> : <code>"1.3 L R2"</code></p> <p>To use attributes with Campaigns or State Templates, you must include them using the request parameters <code>dataExtraDimensions</code> and/or <code>metadataExtraDimensions</code> (for state templates only) when creating your campaign/state template.</p><br>
10 /// - [`association_behavior(VehicleAssociationBehavior)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::association_behavior) / [`set_association_behavior(Option<VehicleAssociationBehavior>)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::set_association_behavior):<br>required: **false**<br><p>An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.</p> <p>Default: <code></code></p><br>
11 /// - [`tags(Tag)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::set_tags):<br>required: **false**<br><p>Metadata that can be used to manage the vehicle.</p><br>
12 /// - [`state_templates(StateTemplateAssociation)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::state_templates) / [`set_state_templates(Option<Vec::<StateTemplateAssociation>>)`](crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::set_state_templates):<br>required: **false**<br><p>Associate state templates with the vehicle. You can monitor the last known state of the vehicle in near real time.</p><br>
13 /// - On success, responds with [`CreateVehicleOutput`](crate::operation::create_vehicle::CreateVehicleOutput) with field(s):
14 /// - [`vehicle_name(Option<String>)`](crate::operation::create_vehicle::CreateVehicleOutput::vehicle_name): <p>The unique ID of the created vehicle.</p>
15 /// - [`arn(Option<String>)`](crate::operation::create_vehicle::CreateVehicleOutput::arn): <p>The ARN of the created vehicle.</p>
16 /// - [`thing_arn(Option<String>)`](crate::operation::create_vehicle::CreateVehicleOutput::thing_arn): <p>The ARN of a created or validated Amazon Web Services IoT thing.</p>
17 /// - On failure, responds with [`SdkError<CreateVehicleError>`](crate::operation::create_vehicle::CreateVehicleError)
18 pub fn create_vehicle(&self) -> crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder {
19 crate::operation::create_vehicle::builders::CreateVehicleFluentBuilder::new(self.handle.clone())
20 }
21}