Skip to content

CreateVehicleRequest

Source code in docs_src/capo_iotfleetwise/types/create_vehicle_request.py
class CreateVehicleRequest(TypedDict, closed=True):
    vehicle_name: "capo_iotfleetwise.types.vehicle_name.vehicleName"
    """<p> The unique ID of the vehicle to create. </p>"""
    model_manifest_arn: "capo_iotfleetwise.types.arn.arn"
    """<p> The Amazon Resource Name ARN of a vehicle model. </p>"""
    decoder_manifest_arn: "capo_iotfleetwise.types.arn.arn"
    """<p> The ARN of a decoder manifest. </p>"""
    attributes: NotRequired["capo_iotfleetwise.types.attributes_map.attributesMap"]
    """<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>"""
    association_behavior: NotRequired[
        "capo_iotfleetwise.types.vehicle_association_behavior.VehicleAssociationBehavior"
    ]
    """<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/> </p>"""
    tags: NotRequired["capo_iotfleetwise.types.tag_list.TagList"]
    """<p>Metadata that can be used to manage the vehicle.</p>"""
    state_templates: NotRequired[
        "capo_iotfleetwise.types.state_template_associations.StateTemplateAssociations"
    ]
    """<p>Associate state templates with the vehicle. You can monitor the last known state of the vehicle in near real time.</p>"""

association_behavior instance-attribute

association_behavior: NotRequired[VehicleAssociationBehavior]

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.

Default:

attributes instance-attribute

attributes: NotRequired[attributesMap]

Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"

To use attributes with Campaigns or State Templates, you must include them using the request parameters dataExtraDimensions and/or metadataExtraDimensions (for state templates only) when creating your campaign/state template.

decoder_manifest_arn instance-attribute

decoder_manifest_arn: arn

The ARN of a decoder manifest.

model_manifest_arn instance-attribute

model_manifest_arn: arn

The Amazon Resource Name ARN of a vehicle model.

state_templates instance-attribute

state_templates: NotRequired[StateTemplateAssociations]

Associate state templates with the vehicle. You can monitor the last known state of the vehicle in near real time.

tags instance-attribute

tags: NotRequired[TagList]

Metadata that can be used to manage the vehicle.

vehicle_name instance-attribute

vehicle_name: vehicleName

The unique ID of the vehicle to create.