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.
Note
If you have an existing AWS IoT thing, you can use AWS IoT FleetWise to create a vehicle and collect data from your thing.
For more information, see Create a vehicle (AWS CLI) in the AWS IoT FleetWise Developer Guide.
Request Syntax
{
"associationBehavior": "string",
"attributes": {
"string" : "string"
},
"decoderManifestArn": "string",
"modelManifestArn": "string",
"stateTemplates": [
{
"identifier": "string",
"stateTemplateUpdateStrategy": { ... }
}
],
"tags": [
{
"Key": "string",
"Value": "string"
}
],
"vehicleName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- associationBehavior
-
An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing AWS IoT thing as a vehicle.
Default:
Type: String
Valid Values:
CreateIotThing | ValidateIotThingExistsRequired: No
- attributes
-
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
dataExtraDimensionsand/ormetadataExtraDimensions(for state templates only) when creating your campaign/state template.Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 150.
Key Pattern:
[a-zA-Z0-9_.-]+Required: No
- decoderManifestArn
-
The ARN of a decoder manifest.
Type: String
Required: Yes
- modelManifestArn
-
The Amazon Resource Name ARN of a vehicle model.
Type: String
Required: Yes
- stateTemplates
-
Associate state templates with the vehicle. You can monitor the last known state of the vehicle in near real time.
Type: Array of StateTemplateAssociation objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required: No
-
Metadata that can be used to manage the vehicle.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
- vehicleName
-
The unique ID of the vehicle to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z\d\-_:]+Required: Yes
Response Syntax
{
"arn": "string",
"thingArn": "string",
"vehicleName": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- arn
-
The ARN of the created vehicle.
Type: String
- thingArn
-
The ARN of a created or validated AWS IoT thing.
Type: String
- vehicleName
-
The unique ID of the created vehicle.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z\d\-_:]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient permission to perform this action.
HTTP Status Code: 400
- ConflictException
-
The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
HTTP Status Code: 400
- InternalServerException
-
The request couldn't be completed because the server temporarily failed.
HTTP Status Code: 500
- LimitExceededException
-
A service quota was exceeded.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource wasn't found.
HTTP Status Code: 400
- ThrottlingException
-
The request couldn't be completed due to throttling.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
