Amazon IoT FleetWise #X Amz Target=IoTAutobahnControlPlane.CreateDecoderManifest API

openapi: 3.0.0
info:
  version: '2021-06-17'
  x-release: v4
  title: 'AWS IoT FleetWise #X Amz Target=IoTAutobahnControlPlane.AssociateVehicleFleet #X Amz Target=IoTAutobahnControlPlane.AssociateVehicleFleet #X Amz Target=IoTAutobahnControlPlane.CreateDecoderManifest API'
  description: <p>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. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/">What is Amazon Web Services IoT FleetWise?</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
  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.CreateDecoderManifest'
paths:
  /#X-Amz-Target=IoTAutobahnControlPlane.CreateDecoderManifest:
    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: CreateDecoderManifest
      description: <p>Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true:</p> <ul> <li> <p>Every signal decoder has a unique name.</p> </li> <li> <p>Each signal decoder is associated with a network interface.</p> </li> <li> <p>Each network interface has a unique ID.</p> </li> <li> <p>The signal decoders are specified in the model manifest.</p> </li> </ul>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDecoderManifestResponse'
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '482':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '483':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '484':
          description: DecoderManifestValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecoderManifestValidationException'
        '485':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '486':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '487':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDecoderManifestRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - IoTAutobahnControlPlane.CreateDecoderManifest
      summary: Amazon IoT FleetWise Create Decoder Manifest
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=IoTAutobahnControlPlane.CreateDecoderManifest'
components:
  schemas:
    CreateDecoderManifestRequest:
      type: object
      required:
      - name
      - modelManifestArn
      title: CreateDecoderManifestRequest
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/resourceName'
          - description: ' The unique name of the decoder manifest to create.'
        description:
          allOf:
          - $ref: '#/components/schemas/description'
          - description: ' A brief description of the decoder manifest. '
        modelManifestArn:
          allOf:
          - $ref: '#/components/schemas/arn'
          - description: ' The Amazon Resource Name (ARN) of the vehicle model (model manifest). '
        signalDecoders:
          allOf:
          - $ref: '#/components/schemas/SignalDecoders'
          - description: ' A list of information about signal decoders. '
        networkInterfaces:
          allOf:
          - $ref: '#/components/schemas/NetworkInterfaces'
          - description: ' A list of information about available network interfaces. '
        tags:
          allOf:
          - $ref: '#/components/schemas/TagList'
          - description: Metadata that can be used to manage the decoder manifest.
    ObdBitmaskLength:
      type: integer
      minimum: 1
      maximum: 8
    CanInterface:
      type: object
      required:
      - name
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/CanInterfaceName'
          - description: The unique name of the interface.
        protocolName:
          allOf:
          - $ref: '#/components/schemas/ProtocolName'
          - description: The name of the communication protocol for the interface.
        protocolVersion:
          allOf:
          - $ref: '#/components/schemas/ProtocolVersion'
          - description: The version of the communication protocol for the interface.
      description: A single controller area network (CAN) device interface.
    InterfaceId:
      type: string
      minLength: 1
      maxLength: 50
    SignalDecoders:
      type: array
      items:
        $ref: '#/components/schemas/SignalDecoder'
      minItems: 1
      maxItems: 500
    InternalServerException: {}
    ThrottlingException: {}
    ObdInterfaceName:
      type: string
      minLength: 1
      maxLength: 100
    TagValue:
      type: string
      minLength: 0
      maxLength: 256
    Tag:
      type: object
      required:
      - Key
      - Value
      properties:
        Key:
          allOf:
          - $ref: '#/components/schemas/TagKey'
          - description: The tag's key.
        Value:
          allOf:
          - $ref: '#/components/schemas/TagValue'
          - description: The tag's value.
      description: A set of key/value pairs that are used to manage the resource.
    ObdStandard:
      type: string
      minLength: 1
      maxLength: 50
    ObdInterface:
      type: object
      required:
      - name
      - requestMessageId
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/ObdInterfaceName'
          - description: The name of the interface.
        requestMessageId:
          allOf:
          - $ref: '#/components/schemas/nonNegativeInteger'
          - description: The ID of the message requesting vehicle data.
        obdStandard:
          allOf:
          - $ref: '#/components/schemas/ObdStandard'
          - description: The standard OBD II PID.
        pidRequestIntervalSeconds:
          allOf:
          - $ref: '#/components/schemas/nonNegativeInteger'
          - description: The maximum number message requests per second.
        dtcRequestIntervalSeconds:
          allOf:
          - $ref: '#/components/schemas/nonNegativeInteger'
          - description: The maximum number message requests per diagnostic trouble code per second.
        useExtendedIds:
          allOf:
          - $ref: '#/components/schemas/boolean'
          - description: Whether to use extended IDs in the message.
        hasTransmissionEcu:
          allOf:
          - $ref: '#/components/schemas/boolean'
          - description: Whether the vehicle has a transmission control module (TCM).
      description: A network interface that specifies the On-board diagnostic (OBD) II network protocol.
    LimitExceededException: {}
    ConflictException: {}
    arn:
      type: string
    double:
      type: number
      format: double
    nonNegativeInteger:
      type: integer
      minimum: 0
    NetworkInterfaceType:
      type: string
      enum:
      - CAN_INTERFACE
      - OBD_INTERFACE
    NetworkInterface:
      type: object
      required:
      - interfaceId
      - type
      properties:
        interfaceId:
          allOf:
          - $ref: '#/components/schemas/InterfaceId'
          - description: The ID of the network interface.
        type:
          allOf:
          - $ref: '#/components/schemas/NetworkInterfaceType'
          - description: The network protocol for the vehicle. For example, <code>CAN_SIGNAL</code> specifies a protocol that defines how data is communicated between electronic control units (ECUs). <code>OBD_SIGNAL</code> 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: <p>Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node. </p> <p> To return this information about all the network interfaces specified in a decoder manifest, use the API operation.</p>
    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: <p>Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).</p> <p>This value might be different from the value in a DBC file. For little endian signals, <code>startBit</code> 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 <code>startBit</code>.</p>
        offset:
          allOf:
          - $ref: '#/components/schemas/double'
          - description: The offset used to calculate the signal value. Combined with factor, the calculation is <code>value = raw_value * factor + offset</code>.
        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 <code>value = raw_value * scaling + offset</code>.
        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.
    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, <code>CAN_SIGNAL</code> specifies a protocol that defines how data is communicated between electronic control units (ECUs). <code>OBD_SIGNAL</code> 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.
    CreateDecoderManifestResponse:
      type: object
      required:
      - name
      - arn
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/resourceName'
          - description: ' The name of the created decoder manifest. '
        arn:
          allOf:
          - $ref: '#/components/schemas/arn'
          - description: ' The ARN of the created decoder manifest. '
    boolean:
      type: boolean
    ValidationException: {}
    SignalDecoderType:
      type: string
      enum:
      - CAN_SIGNAL
      - OBD_SIGNAL
    ObdByteLength:
      type: integer
      minimum: 1
      maximum: 8
    TagKey:
      type: string
      minLength: 1
      maxLength: 128
    positiveInteger:
      type: integer
      minimum: 1
    ProtocolName:
      type: string
      minLength: 1
      maxLength: 50
    CanSignalName:
      type: string
      minLength: 1
      maxLength: 100
    TagList:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
      minItems: 0
      maxItems: 50
  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