CreateDecoderManifest - AWS IoT FleetWise

CreateDecoderManifest

Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true:

  • Every signal decoder has a unique name.

  • Each signal decoder is associated with a network interface.

  • Each network interface has a unique ID.

  • The signal decoders are specified in the model manifest.

Request Syntax

{ "description": "string", "modelManifestArn": "string", "name": "string", "networkInterfaces": [ { "canInterface": { "name": "string", "protocolName": "string", "protocolVersion": "string" }, "interfaceId": "string", "obdInterface": { "dtcRequestIntervalSeconds": number, "hasTransmissionEcu": boolean, "name": "string", "obdStandard": "string", "pidRequestIntervalSeconds": number, "requestMessageId": number, "useExtendedIds": boolean }, "type": "string" } ], "signalDecoders": [ { "canSignal": { "factor": number, "isBigEndian": boolean, "isSigned": boolean, "length": number, "messageId": number, "name": "string", "offset": number, "startBit": number }, "fullyQualifiedName": "string", "interfaceId": "string", "obdSignal": { "bitMaskLength": number, "bitRightShift": number, "byteLength": number, "offset": number, "pid": number, "pidResponseLength": number, "scaling": number, "serviceMode": number, "startByte": number }, "type": "string" } ], "tags": [ { "Key": "string", "Value": "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.

description

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

The Amazon Resource Name (ARN) of the vehicle model (model manifest).

Type: String

Required: Yes

name

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

A list of information about available network interfaces.

Type: Array of NetworkInterface objects

Array Members: Minimum number of 1 item. Maximum number of 500 items.

Required: No

signalDecoders

A list of information about signal decoders.

Type: Array of SignalDecoder objects

Array Members: Minimum number of 1 item. Maximum number of 500 items.

Required: No

tags

Metadata that can be used to manage the decoder manifest.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 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

The ARN of the created decoder manifest.

Type: String

name

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.

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: