Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.
If you have an existing Amazon Web Services IoT Thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing.
For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
Synopsis
- data CreateVehicle = CreateVehicle' {}
- newCreateVehicle :: Text -> Text -> Text -> CreateVehicle
- createVehicle_associationBehavior :: Lens' CreateVehicle (Maybe VehicleAssociationBehavior)
- createVehicle_attributes :: Lens' CreateVehicle (Maybe (HashMap Text Text))
- createVehicle_tags :: Lens' CreateVehicle (Maybe [Tag])
- createVehicle_vehicleName :: Lens' CreateVehicle Text
- createVehicle_modelManifestArn :: Lens' CreateVehicle Text
- createVehicle_decoderManifestArn :: Lens' CreateVehicle Text
- data CreateVehicleResponse = CreateVehicleResponse' {}
- newCreateVehicleResponse :: Int -> CreateVehicleResponse
- createVehicleResponse_arn :: Lens' CreateVehicleResponse (Maybe Text)
- createVehicleResponse_thingArn :: Lens' CreateVehicleResponse (Maybe Text)
- createVehicleResponse_vehicleName :: Lens' CreateVehicleResponse (Maybe Text)
- createVehicleResponse_httpStatus :: Lens' CreateVehicleResponse Int
Creating a Request
data CreateVehicle Source #
See: newCreateVehicle
smart constructor.
CreateVehicle' | |
|
Instances
Create a value of CreateVehicle
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateVehicle
, createVehicle_associationBehavior
- 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:
CreateVehicle
, createVehicle_attributes
- Static information about a vehicle in a key-value pair. For example:
"engineType"
: "1.3 L R2"
CreateVehicle
, createVehicle_tags
- Metadata that can be used to manage the vehicle.
CreateVehicle
, createVehicle_vehicleName
- The unique ID of the vehicle to create.
CreateVehicle
, createVehicle_modelManifestArn
- The Amazon Resource Name ARN of a vehicle model.
CreateVehicle
, createVehicle_decoderManifestArn
- The ARN of a decoder manifest.
Request Lenses
createVehicle_associationBehavior :: Lens' CreateVehicle (Maybe VehicleAssociationBehavior) Source #
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:
createVehicle_attributes :: Lens' CreateVehicle (Maybe (HashMap Text Text)) Source #
Static information about a vehicle in a key-value pair. For example:
"engineType"
: "1.3 L R2"
createVehicle_tags :: Lens' CreateVehicle (Maybe [Tag]) Source #
Metadata that can be used to manage the vehicle.
createVehicle_vehicleName :: Lens' CreateVehicle Text Source #
The unique ID of the vehicle to create.
createVehicle_modelManifestArn :: Lens' CreateVehicle Text Source #
The Amazon Resource Name ARN of a vehicle model.
createVehicle_decoderManifestArn :: Lens' CreateVehicle Text Source #
The ARN of a decoder manifest.
Destructuring the Response
data CreateVehicleResponse Source #
See: newCreateVehicleResponse
smart constructor.
Instances
newCreateVehicleResponse Source #
Create a value of CreateVehicleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateVehicleResponse
, createVehicleResponse_arn
- The ARN of the created vehicle.
CreateVehicleResponse
, createVehicleResponse_thingArn
- The ARN of a created or validated Amazon Web Services IoT thing.
CreateVehicle
, createVehicleResponse_vehicleName
- The unique ID of the created vehicle.
$sel:httpStatus:CreateVehicleResponse'
, createVehicleResponse_httpStatus
- The response's http status code.
Response Lenses
createVehicleResponse_arn :: Lens' CreateVehicleResponse (Maybe Text) Source #
The ARN of the created vehicle.
createVehicleResponse_thingArn :: Lens' CreateVehicleResponse (Maybe Text) Source #
The ARN of a created or validated Amazon Web Services IoT thing.
createVehicleResponse_vehicleName :: Lens' CreateVehicleResponse (Maybe Text) Source #
The unique ID of the created vehicle.
createVehicleResponse_httpStatus :: Lens' CreateVehicleResponse Int Source #
The response's http status code.