decoder_manifests

Creates, updates, deletes, gets or lists a decoder_manifests resource.

Overview

Name	decoder_manifests
Type	Resource
Id	aws.iotfleetwise.decoder_manifests

Fields

The following fields are returned by SELECT queries:

get_decoder_manifest

Name	Datatype	Description
name	string	The name of the decoder manifest.
arn	string	The Amazon Resource Name (ARN) of the decoder manifest.
creation_time	string (date-time)	The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
description	string	A brief description of the decoder manifest. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
last_modification_time	string (date-time)	The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
message	string	The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
model_manifest_arn	string	The ARN of a vehicle model (model manifest) associated with the decoder manifest.
status	string	The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is marked DRAFT, you can edit the decoder manifest. (ACTIVE, DRAFT, INVALID, VALIDATING)

list_decoder_manifests

Name	Datatype	Description
name	string	The name of the decoder manifest.
arn	string	The ARN of a vehicle model (model manifest) associated with the decoder manifest.
creation_time	string (date-time)	The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
description	string	A brief description of the decoder manifest. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
last_modification_time	string (date-time)	The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
message	string	The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
model_manifest_arn	string	The ARN of a vehicle model (model manifest) associated with the decoder manifest.
status	string	The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is marked DRAFT, you can edit the decoder manifest. (ACTIVE, DRAFT, INVALID, VALIDATING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_decoder_manifest	select	region		Retrieves information about a created decoder manifest.
list_decoder_manifests	select	region		Lists decoder manifests. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
create_decoder_manifest	insert	region, name, modelManifestArn		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.
update_decoder_manifest	update	region, name		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.
delete_decoder_manifest	delete	region		Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_decoder_manifest

Retrieves information about a created decoder manifest.

SELECT
name,
arn,
creation_time,
description,
last_modification_time,
message,
model_manifest_arn,
status
FROM aws.iotfleetwise.decoder_manifests
WHERE region = '{{ region }}' -- required
;

list_decoder_manifests

Lists decoder manifests. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

SELECT
name,
arn,
creation_time,
description,
last_modification_time,
message,
model_manifest_arn,
status
FROM aws.iotfleetwise.decoder_manifests
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_decoder_manifest

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.

INSERT INTO aws.iotfleetwise.decoder_manifests (
name,
description,
modelManifestArn,
signalDecoders,
networkInterfaces,
defaultForUnmappedSignals,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ modelManifestArn }}' /* required */,
'{{ signalDecoders }}',
'{{ networkInterfaces }}',
'{{ defaultForUnmappedSignals }}',
'{{ tags }}',
'{{ region }}'
RETURNING
name,
arn
;

Manifest

# Description fields are for documentation purposes
- name: decoder_manifests
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the decoder_manifests resource.
  - name: name
    value: "{{ name }}"
    description: |
      The unique name of the decoder manifest to create.
  - name: description
    value: "{{ description }}"
    description: |
      A brief description of the decoder manifest.
  - name: modelManifestArn
    value: "{{ modelManifestArn }}"
    description: |
      The Amazon Resource Name (ARN) of the vehicle model (model manifest).
  - name: signalDecoders
    description: |
      A list of information about signal decoders.
    value:
      - fullyQualifiedName: "{{ fullyQualifiedName }}"
        type_: "{{ type_ }}"
        interfaceId: "{{ interfaceId }}"
        canSignal:
          messageId: {{ messageId }}
          isBigEndian: {{ isBigEndian }}
          isSigned: {{ isSigned }}
          startBit: {{ startBit }}
          offset: {{ offset }}
          factor: {{ factor }}
          length: {{ length }}
          name: "{{ name }}"
          signalValueType: "{{ signalValueType }}"
        obdSignal:
          pidResponseLength: {{ pidResponseLength }}
          serviceMode: {{ serviceMode }}
          pid: {{ pid }}
          scaling: {{ scaling }}
          offset: {{ offset }}
          startByte: {{ startByte }}
          byteLength: {{ byteLength }}
          bitRightShift: {{ bitRightShift }}
          bitMaskLength: {{ bitMaskLength }}
          isSigned: {{ isSigned }}
          signalValueType: "{{ signalValueType }}"
        messageSignal:
          topicName: "{{ topicName }}"
          structuredMessage:
            primitiveMessageDefinition:
              ros2PrimitiveMessageDefinition:
                primitiveType: "{{ primitiveType }}"
                offset: {{ offset }}
                scaling: {{ scaling }}
                upperBound: {{ upperBound }}
            structuredMessageListDefinition:
              name: "{{ name }}"
              memberType:
                primitiveMessageDefinition: "{{ primitiveMessageDefinition }}"
                structuredMessageListDefinition: "{{ structuredMessageListDefinition }}"
                structuredMessageDefinition: "{{ structuredMessageDefinition }}"
              listType: "{{ listType }}"
              capacity: {{ capacity }}
            structuredMessageDefinition:
              - fieldName: "{{ fieldName }}"
                dataType:
                  primitiveMessageDefinition: "{{ primitiveMessageDefinition }}"
                  structuredMessageListDefinition: "{{ structuredMessageListDefinition }}"
                  structuredMessageDefinition: "{{ structuredMessageDefinition }}"
        customDecodingSignal:
          id: "{{ id }}"
  - name: networkInterfaces
    description: |
      A list of information about available network interfaces.
    value:
      - interfaceId: "{{ interfaceId }}"
        type_: "{{ type_ }}"
        canInterface:
          name: "{{ name }}"
          protocolName: "{{ protocolName }}"
          protocolVersion: "{{ protocolVersion }}"
        obdInterface:
          name: "{{ name }}"
          requestMessageId: {{ requestMessageId }}
          obdStandard: "{{ obdStandard }}"
          pidRequestIntervalSeconds: {{ pidRequestIntervalSeconds }}
          dtcRequestIntervalSeconds: {{ dtcRequestIntervalSeconds }}
          useExtendedIds: {{ useExtendedIds }}
          hasTransmissionEcu: {{ hasTransmissionEcu }}
        vehicleMiddleware:
          name: "{{ name }}"
          protocolName: "{{ protocolName }}"
        customDecodingInterface:
          name: "{{ name }}"
  - name: defaultForUnmappedSignals
    value: "{{ defaultForUnmappedSignals }}"
    description: |
      Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information. Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.
    valid_values: ['CUSTOM_DECODING']
  - name: tags
    description: |
      Metadata that can be used to manage the decoder manifest.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_decoder_manifest

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.

UPDATE aws.iotfleetwise.decoder_manifests
SET 
name = '{{ name }}',
description = '{{ description }}',
signalDecodersToAdd = '{{ signalDecodersToAdd }}',
signalDecodersToUpdate = '{{ signalDecodersToUpdate }}',
signalDecodersToRemove = '{{ signalDecodersToRemove }}',
networkInterfacesToAdd = '{{ networkInterfacesToAdd }}',
networkInterfacesToUpdate = '{{ networkInterfacesToUpdate }}',
networkInterfacesToRemove = '{{ networkInterfacesToRemove }}',
status = '{{ status }}',
defaultForUnmappedSignals = '{{ defaultForUnmappedSignals }}'
WHERE 
region = '{{ region }}' --required
AND name = '{{ name }}' --required
RETURNING
name,
arn;

DELETE examples

delete_decoder_manifest

Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it.

DELETE FROM aws.iotfleetwise.decoder_manifests
WHERE region = '{{ region }}' --required
;