UpdateDecoderManifest
Updates a decoder manifest.
A decoder manifest can only be updated when the status is DRAFT. Only
ACTIVE decoder manifests can be associated with vehicles.
Request Syntax
{
"defaultForUnmappedSignals": "string",
"description": "string",
"name": "string",
"networkInterfacesToAdd": [
{
"canInterface": {
"name": "string",
"protocolName": "string",
"protocolVersion": "string"
},
"customDecodingInterface": {
"name": "string"
},
"interfaceId": "string",
"obdInterface": {
"dtcRequestIntervalSeconds": number,
"hasTransmissionEcu": boolean,
"name": "string",
"obdStandard": "string",
"pidRequestIntervalSeconds": number,
"requestMessageId": number,
"useExtendedIds": boolean
},
"type": "string",
"vehicleMiddleware": {
"name": "string",
"protocolName": "string"
}
}
],
"networkInterfacesToRemove": [ "string" ],
"networkInterfacesToUpdate": [
{
"canInterface": {
"name": "string",
"protocolName": "string",
"protocolVersion": "string"
},
"customDecodingInterface": {
"name": "string"
},
"interfaceId": "string",
"obdInterface": {
"dtcRequestIntervalSeconds": number,
"hasTransmissionEcu": boolean,
"name": "string",
"obdStandard": "string",
"pidRequestIntervalSeconds": number,
"requestMessageId": number,
"useExtendedIds": boolean
},
"type": "string",
"vehicleMiddleware": {
"name": "string",
"protocolName": "string"
}
}
],
"signalDecodersToAdd": [
{
"canSignal": {
"factor": number,
"isBigEndian": boolean,
"isSigned": boolean,
"length": number,
"messageId": number,
"name": "string",
"offset": number,
"signalValueType": "string",
"startBit": number
},
"customDecodingSignal": {
"id": "string"
},
"fullyQualifiedName": "string",
"interfaceId": "string",
"messageSignal": {
"structuredMessage": { ... },
"topicName": "string"
},
"obdSignal": {
"bitMaskLength": number,
"bitRightShift": number,
"byteLength": number,
"isSigned": boolean,
"offset": number,
"pid": number,
"pidResponseLength": number,
"scaling": number,
"serviceMode": number,
"signalValueType": "string",
"startByte": number
},
"type": "string"
}
],
"signalDecodersToRemove": [ "string" ],
"signalDecodersToUpdate": [
{
"canSignal": {
"factor": number,
"isBigEndian": boolean,
"isSigned": boolean,
"length": number,
"messageId": number,
"name": "string",
"offset": number,
"signalValueType": "string",
"startBit": number
},
"customDecodingSignal": {
"id": "string"
},
"fullyQualifiedName": "string",
"interfaceId": "string",
"messageSignal": {
"structuredMessage": { ... },
"topicName": "string"
},
"obdSignal": {
"bitMaskLength": number,
"bitRightShift": number,
"byteLength": number,
"isSigned": boolean,
"offset": number,
"pid": number,
"pidResponseLength": number,
"scaling": number,
"serviceMode": number,
"signalValueType": "string",
"startByte": number
},
"type": "string"
}
],
"status": "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.
- defaultForUnmappedSignals
-
Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.
Important
Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide.
Type: String
Valid Values:
CUSTOM_DECODINGRequired: No
- description
-
A brief description of the decoder manifest to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[^\u0000-\u001F\u007F]+Required: No
- name
-
The name of the decoder manifest to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z\d\-_:]+Required: Yes
- networkInterfacesToAdd
-
A list of information about the network interfaces to add to the decoder manifest.
Type: Array of NetworkInterface objects
Array Members: Minimum number of 1 item. Maximum number of 500 items.
Required: No
- networkInterfacesToRemove
-
A list of network interfaces to remove from the decoder manifest.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 500 items.
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: No
- networkInterfacesToUpdate
-
A list of information about the network interfaces to update in the decoder manifest.
Type: Array of NetworkInterface objects
Array Members: Minimum number of 1 item. Maximum number of 500 items.
Required: No
- signalDecodersToAdd
-
A list of information about decoding additional signals to add to the decoder manifest.
Type: Array of SignalDecoder objects
Array Members: Minimum number of 1 item. Maximum number of 500 items.
Required: No
- signalDecodersToRemove
-
A list of signal decoders to remove from the decoder manifest.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 500 items.
Length Constraints: Minimum length of 1. Maximum length of 150.
Required: No
- signalDecodersToUpdate
-
A list of updated information about decoding signals to update in the decoder manifest.
Type: Array of SignalDecoder objects
Array Members: Minimum number of 1 item. Maximum number of 500 items.
Required: No
- status
-
The state of the decoder manifest. If the status is
ACTIVE, the decoder manifest can't be edited. If the status isDRAFT, you can edit the decoder manifest.Type: String
Valid Values:
ACTIVE | DRAFT | INVALID | VALIDATINGRequired: 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.
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
- DecoderManifestValidationException
-
The request couldn't be completed because it contains signal decoders with one or more validation errors.
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:
