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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2021-06-17 16
CreateDecoderManifest
CreateDecoderManifest
Creates the decoder manifest associated with a model manifest. To create a decoder manifest:
• Every signal decoder must have a unique name.
• Each signal decoder must be associated with a network interface.
• Network interfaces must have a unique ID.
• The signal decoders must be specified in the model manifest.
Request Syntax
{ "description": "string", "modelManifestArn": "string", "name": "string",
"networkInterfaces": [ {
"signalDecoders": [ {
AWS IoT FleetWise Welcome
For information about the parameters that are common to all actions, see Common Parameters (p. 198).
The request accepts the following data in JSON format.
description (p. 17)
A brief description of the decoder manifest.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^[^\u0000-\u001F\u007F]+$
Required: No
modelManifestArn (p. 17)
The Amazon Resource Name (ARN) of the vehicle model (model manifest).
Type: String Required: Yes name (p. 17)
The unique name of the decoder manifest to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[a-zA-Z\d\-_:]+$
Required: Yes
networkInterfaces (p. 17)
A list of information about available network interfaces.
Type: Array of NetworkInterface (p. 171) objects
Array Members: Minimum number of 1 item. Maximum number of 500 items.
Required: No signalDecoders (p. 17)
A list of information about signal decoders.
Type: Array of SignalDecoder (p. 182) objects
Array Members: Minimum number of 1 item. Maximum number of 500 items.
Required: No
API Version 2021-06-17 18
Response Syntax
Response Syntax
{
"arn": "string", "name": "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 (p. 19)
The ARN of the created decoder manifest.
Type: String name (p. 19)
The name of the created decoder manifest.
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 (p. 200).
AccessDeniedException
You don't have sufficient permission to perform this action.
HTTP Status Code: 400 ConflictException
Your 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
DecoderManifestValidationException
The request couldn't be completed because it contains signal decoders with one or more validation errors.
HTTP Status Code: 400 ResourceNotFoundException
The resource wasn't found.
HTTP Status Code: 400 ServiceQuotaExceededException
A service quota was exceeded.
AWS IoT FleetWise Welcome See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2021-06-17 20
CreateFleet
CreateFleet
Creates a fleet that represents a group of vehicles.
NoteYou must create both a signal catalog and vehicles before you can create a fleet.
For more information, see Fleets in the AWS IoT FleetWise Developer Guide.
Request Syntax
{
"description": "string", "fleetId": "string",
"signalCatalogArn": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 198).
The request accepts the following data in JSON format.
description (p. 21)
A brief description of the fleet to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^[^\u0000-\u001F\u007F]+$
Required: No fleetId (p. 21)
The unique ID of the fleet to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[a-zA-Z0-9:_-]+$
Required: Yes signalCatalogArn (p. 21)
The Amazon Resource Name (ARN) of a signal catalog.
Type: String Required: Yes
Response Syntax
{
AWS IoT FleetWise Welcome Response Elements
"arn": "string", "id": "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 (p. 21)
The ARN of the created fleet.
Type: String id (p. 21)
The ID of the created fleet.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[a-zA-Z0-9:_-]+$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 200).
AccessDeniedException
You don't have sufficient permission to perform this action.
HTTP Status Code: 400 ConflictException
Your 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 ResourceNotFoundException
The resource wasn't found.
HTTP Status Code: 400 ServiceQuotaExceededException
A service quota was exceeded.
HTTP Status Code: 400 ThrottlingException
The request couldn't be completed due to throttling.
API Version 2021-06-17 22
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AWS IoT FleetWise Welcome CreateModelManifest
CreateModelManifest
Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).
For more information, see Vehicle models in the AWS IoT FleetWise Developer Guide.
Request Syntax
{
"description": "string", "name": "string",
"nodes": [ "string" ], "signalCatalogArn": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 198).
The request accepts the following data in JSON format.
description (p. 24)
A brief description of the vehicle model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^[^\u0000-\u001F\u007F]+$
Required: No name (p. 24)
The name of the vehicle model to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[a-zA-Z\d\-_:]+$
Required: Yes nodes (p. 24)
A list of nodes, which are a general abstraction of signals.
Type: Array of strings Required: Yes signalCatalogArn (p. 24)
The Amazon Resource Name (ARN) of a signal catalog.
Type: String
API Version 2021-06-17 24
Response Syntax
Required: Yes
Response Syntax
{ "arn": "string", "name": "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 (p. 25)
The ARN of the created vehicle model.
Type: String name (p. 25)
The name of the created vehicle model.
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 (p. 200).
AccessDeniedException
You don't have sufficient permission to perform this action.
HTTP Status Code: 400 ConflictException
Your 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 InvalidSignalsException
The request couldn't be completed because it contains signals that aren't valid.
HTTP Status Code: 400 ResourceNotFoundException
The resource wasn't found.
HTTP Status Code: 400
AWS IoT FleetWise Welcome See Also
ServiceQuotaExceededException A service quota was exceeded.
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2021-06-17 26
CreateSignalCatalog
CreateSignalCatalog
Creates a collection of standardized signals that can be reused to create vehicle models.
Request Syntax
{
"description": "string", "name": "string",
"nodes": [
For information about the parameters that are common to all actions, see Common Parameters (p. 198).
The request accepts the following data in JSON format.
AWS IoT FleetWise Welcome Response Syntax
description (p. 27)
A brief description of the signal catalog.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^[^\u0000-\u001F\u007F]+$
Required: No name (p. 27)
The name of the signal catalog to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[a-zA-Z\d\-_:]+$
Required: Yes nodes (p. 27)
A list of information about nodes, which are a general abstraction of signals. For more information, see the Node (p. 172) API data type.
Type: Array of Node (p. 172) objects
Array Members: Minimum number of 0 items. Maximum number of 500 items.
Required: No
Response Syntax
{
"arn": "string", "name": "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 (p. 28)
The ARN of the created signal catalog.
Type: String name (p. 28)
The name of the created signal catalog.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
API Version 2021-06-17 28
Errors
Pattern: ^[a-zA-Z\d\-_:]+$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 200).
AccessDeniedException
You don't have sufficient permission to perform this action.
HTTP Status Code: 400 ConflictException
Your 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 InvalidSignalsException
The request couldn't be completed because it contains signals that aren't valid.
HTTP Status Code: 400 ServiceQuotaExceededException
A service quota was exceeded.
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AWS IoT FleetWise Welcome CreateVehicle
CreateVehicle
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.
NoteIf 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", "vehicleId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 198).
The request accepts the following data in JSON format.
associationBehavior (p. 30)
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 | ValidateIotThingExists Required: No
attributes (p. 30)
Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"
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 (p. 30)
The (ARN) of a decoder manifest.
Type: String
API Version 2021-06-17 30
Response Syntax
Required: Yes
modelManifestArn (p. 30)
The Amazon Resource Name ARN of a vehicle model.
Type: String Required: Yes vehicleId (p. 30)
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", "id": "string", "thingArn": "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 (p. 31)
The ARN of the created vehicle.
Type: String id (p. 31)
The ID of the created vehicle.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[a-zA-Z\d\-_:]+$
thingArn (p. 31)
The ARN of a created or validated AWS IoT thing.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 200).
AWS IoT FleetWise Welcome See Also
AccessDeniedException
You don't have sufficient permission to perform this action.
HTTP Status Code: 400 ConflictException
Your 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 ResourceNotFoundException
The resource wasn't found.
HTTP Status Code: 400 ServiceQuotaExceededException
A service quota was exceeded.
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2021-06-17 32
DeleteCampaign
DeleteCampaign
Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.
Request Syntax
{ "campaignName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 198).
The request accepts the following data in JSON format.
campaignName (p. 33)
The name of the campaign to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[a-zA-Z\d\-_:]+$
Required: Yes
Response Syntax
{
"arn": "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 (p. 33)
The Amazon Resource Name (ARN) of the deleted campaign.
NoteThe ARN isn’t returned if a campaign doesn’t exist.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 200).
AWS IoT FleetWise Welcome See Also
AccessDeniedException
You don't have sufficient permission to perform this action.
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2021-06-17 34
DeleteDecoderManifest
DeleteDecoderManifest
Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it.
NoteIf the decoder manifest is successfully deleted, AWS IoT FleetWise sends back an HTTP 200 response with an empty body.
Request Syntax
{ "name": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 198).
The request accepts the following data in JSON format.
name (p. 35)
The name of the decoder manifest to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[a-zA-Z\d\-_:]+$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 200).
AccessDeniedException
You don't have sufficient permission to perform this action.
HTTP Status Code: 400 InternalServerException
The request couldn't be completed because the server temporarily failed.
HTTP Status Code: 500 ThrottlingException
The request couldn't be completed due to throttling.
AWS IoT FleetWise Welcome See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2021-06-17 36
DeleteFleet
DeleteFleet
Deletes a fleet. Before you delete a fleet, all vehicles must be dissociated from the fleet. For more information, see Delete a fleet (AWS CLI) in the AWS IoT FleetWise Developer Guide.
NoteIf the fleet is successfully deleted, AWS IoT FleetWise sends back an HTTP 200 response with an empty body.
Request Syntax
{ "fleetId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 198).
The request accepts the following data in JSON format.
fleetId (p. 37)
The ID of the fleet to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[a-zA-Z0-9:_-]+$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 200).
AccessDeniedException
You don't have sufficient permission to perform this action.
HTTP Status Code: 400 InternalServerException
The request couldn't be completed because the server temporarily failed.
HTTP Status Code: 500 ThrottlingException
The request couldn't be completed due to throttling.
AWS IoT FleetWise Welcome See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2021-06-17 38
DeleteModelManifest
DeleteModelManifest
Deletes a vehicle model (model manifest).
NoteIf the vehicle model is successfully deleted, AWS IoT FleetWise sends back an HTTP 200 response with an empty body.
Request Syntax
{ "name": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 198).
The request accepts the following data in JSON format.
name (p. 39)
The name of the vehicle model to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[a-zA-Z\d\-_:]+$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 200).
AccessDeniedException
You don't have sufficient permission to perform this action.
HTTP Status Code: 400 InternalServerException
The request couldn't be completed because the server temporarily failed.
HTTP Status Code: 500 ThrottlingException
The request couldn't be completed due to throttling.
AWS IoT FleetWise Welcome See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2021-06-17 40
DeleteSignalCatalog
DeleteSignalCatalog
Deletes a signal catalog.
NoteIf the signal catalog is successfully deleted, AWS IoT FleetWise sends back an HTTP 200 response with an empty body.
NoteIf the signal catalog is successfully deleted, AWS IoT FleetWise sends back an HTTP 200 response with an empty body.