Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of your vehicle data models, independent of the in-vehicle communication architecture, and define data collection rules to transfer only high-value data to the cloud.
For more information, see What is Amazon Web Services IoT FleetWise? in the Amazon Web Services IoT FleetWise Developer Guide.
x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: iotfleetwise x-aws-signingName: iotfleetwise x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iotfleetwise-2021-06-17.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://iotfleetwise.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS IoT FleetWise multi-region endpoint - url: https://iotfleetwise.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS IoT FleetWise multi-region endpoint - url: http://iotfleetwise.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS IoT FleetWise endpoint for China (Beijing) and China (Ningxia) - url: https://iotfleetwise.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS IoT FleetWise endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=IoTAutobahnControlPlane.UpdateDecoderManifest' paths: /#X-Amz-Target=IoTAutobahnControlPlane.UpdateDecoderManifest: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UpdateDecoderManifest description: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.
CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
canInterface:
allOf:
- $ref: '#/components/schemas/CanInterface'
- description: Information about a network interface specified by the Controller Area Network (CAN) protocol.
obdInterface:
allOf:
- $ref: '#/components/schemas/ObdInterface'
- description: Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
description: Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node.
To return this information about all the network interfaces specified in a decoder manifest, use the API operation.
DecoderManifestValidationException: {} FullyQualifiedName: type: string minLength: 1 maxLength: 150 description: type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 maxLength: 2048 NetworkInterfaces: type: array items: $ref: '#/components/schemas/NetworkInterface' minItems: 1 maxItems: 500 CanSignal: type: object required: - messageId - isBigEndian - isSigned - startBit - offset - factor - length properties: messageId: allOf: - $ref: '#/components/schemas/nonNegativeInteger' - description: The ID of the message. isBigEndian: allOf: - $ref: '#/components/schemas/boolean' - description: Whether the byte ordering of a CAN message is big-endian. isSigned: allOf: - $ref: '#/components/schemas/boolean' - description: Whether the message data is specified as a signed value. startBit: allOf: - $ref: '#/components/schemas/nonNegativeInteger' - description:Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
value = raw_value * factor + offset.
factor:
allOf:
- $ref: '#/components/schemas/double'
- description: A multiplier used to decode the CAN message.
length:
allOf:
- $ref: '#/components/schemas/nonNegativeInteger'
- description: How many bytes of data are in the message.
name:
allOf:
- $ref: '#/components/schemas/CanSignalName'
- description: The name of the signal.
description: Information about a single controller area network (CAN) signal and the messages it receives and transmits.
ResourceNotFoundException: {}
AccessDeniedException: {}
resourceName:
type: string
pattern: '[a-zA-Z\d\-_:]+'
minLength: 1
maxLength: 100
ProtocolVersion:
type: string
minLength: 1
maxLength: 50
ObdSignal:
type: object
required:
- pidResponseLength
- serviceMode
- pid
- scaling
- offset
- startByte
- byteLength
properties:
pidResponseLength:
allOf:
- $ref: '#/components/schemas/positiveInteger'
- description: The length of the requested data.
serviceMode:
allOf:
- $ref: '#/components/schemas/nonNegativeInteger'
- description: The mode of operation (diagnostic service) in a message.
pid:
allOf:
- $ref: '#/components/schemas/nonNegativeInteger'
- description: The diagnostic code used to request data from a vehicle for this signal.
scaling:
allOf:
- $ref: '#/components/schemas/double'
- description: A multiplier used to decode the message.
offset:
allOf:
- $ref: '#/components/schemas/double'
- description: The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.
startByte:
allOf:
- $ref: '#/components/schemas/nonNegativeInteger'
- description: Indicates the beginning of the message.
byteLength:
allOf:
- $ref: '#/components/schemas/ObdByteLength'
- description: The length of a message.
bitRightShift:
allOf:
- $ref: '#/components/schemas/nonNegativeInteger'
- description: The number of positions to shift bits in the message.
bitMaskLength:
allOf:
- $ref: '#/components/schemas/ObdBitmaskLength'
- description: The number of bits to mask in a message.
description: Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
InterfaceIds:
type: array
items:
$ref: '#/components/schemas/InterfaceId'
minItems: 1
maxItems: 500
CanInterfaceName:
type: string
minLength: 1
maxLength: 100
SignalDecoder:
type: object
required:
- fullyQualifiedName
- type
- interfaceId
properties:
fullyQualifiedName:
allOf:
- $ref: '#/components/schemas/FullyQualifiedName'
- description: The fully qualified name of a signal decoder as defined in a vehicle model.
type:
allOf:
- $ref: '#/components/schemas/SignalDecoderType'
- description: The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
interfaceId:
allOf:
- $ref: '#/components/schemas/InterfaceId'
- description: The ID of a network interface that specifies what network protocol a vehicle follows.
canSignal:
allOf:
- $ref: '#/components/schemas/CanSignal'
- description: Information about signal decoder using the Controller Area Network (CAN) protocol.
obdSignal:
allOf:
- $ref: '#/components/schemas/ObdSignal'
- description: Information about signal decoder using the On-board diagnostic (OBD) II protocol.
description: Information about a signal decoder.
ManifestStatus:
type: string
enum:
- ACTIVE
- DRAFT
boolean:
type: boolean
ValidationException: {}
SignalDecoderType:
type: string
enum:
- CAN_SIGNAL
- OBD_SIGNAL
ObdByteLength:
type: integer
minimum: 1
maximum: 8
positiveInteger:
type: integer
minimum: 1
UpdateDecoderManifestRequest:
type: object
required:
- name
title: UpdateDecoderManifestRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/resourceName'
- description: ' The name of the decoder manifest to update.'
description:
allOf:
- $ref: '#/components/schemas/description'
- description: ' A brief description of the decoder manifest to update. '
signalDecodersToAdd:
allOf:
- $ref: '#/components/schemas/SignalDecoders'
- description: ' A list of information about decoding additional signals to add to the decoder manifest. '
signalDecodersToUpdate:
allOf:
- $ref: '#/components/schemas/SignalDecoders'
- description: ' A list of updated information about decoding signals to update in the decoder manifest. '
signalDecodersToRemove:
allOf:
- $ref: '#/components/schemas/Fqns'
- description: ' A list of signal decoders to remove from the decoder manifest. '
networkInterfacesToAdd:
allOf:
- $ref: '#/components/schemas/NetworkInterfaces'
- description: ' A list of information about the network interfaces to add to the decoder manifest. '
networkInterfacesToUpdate:
allOf:
- $ref: '#/components/schemas/NetworkInterfaces'
- description: ' A list of information about the network interfaces to update in the decoder manifest. '
networkInterfacesToRemove:
allOf:
- $ref: '#/components/schemas/InterfaceIds'
- description: ' A list of network interfaces to remove from the decoder manifest.'
status:
allOf:
- $ref: '#/components/schemas/ManifestStatus'
- description: ' The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can''t be edited. If the status is DRAFT, you can edit the decoder manifest. '
CanSignalName:
type: string
minLength: 1
maxLength: 100
parameters:
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/iotfleetwise/
x-hasEquivalentPaths: true