find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-iot-fleetwise:amazon-iot-fleetwise-state-template-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS IoT FleetWise State Template API
  version: '2021-06-17'
  description: Generated from AWS's published Smithy model for AWS IoT FleetWise. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://iotfleetwise.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: State Template
paths:
  /#CreateStateTemplate:
    post:
      operationId: CreateStateTemplate
      summary: Create State Template
      description: Creates a state template. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud. 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateStateTemplateResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException; InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidSignalsException; LimitExceededException; ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidSignalsException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - IoTAutobahnControlPlane.CreateStateTemplate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateStateTemplateRequest'
      tags:
      - State Template
  /#GetStateTemplate:
    post:
      operationId: GetStateTemplate
      summary: Get State Template
      description: Retrieves information about a state template. 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/GetStateTemplateResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException; InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - IoTAutobahnControlPlane.GetStateTemplate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetStateTemplateRequest'
      tags:
      - State Template
  /#UpdateStateTemplate:
    post:
      operationId: UpdateStateTemplate
      summary: Update State Template
      description: Updates a state template. 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateStateTemplateResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException; InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidSignalsException; LimitExceededException; ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidSignalsException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - IoTAutobahnControlPlane.UpdateStateTemplate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateStateTemplateRequest'
      tags:
      - State Template
  /#DeleteStateTemplate:
    post:
      operationId: DeleteStateTemplate
      summary: Delete State Template
      description: Deletes a state template.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteStateTemplateResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException; InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - IoTAutobahnControlPlane.DeleteStateTemplate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteStateTemplateRequest'
      tags:
      - State Template
  /#ListStateTemplates:
    post:
      operationId: ListStateTemplates
      summary: List State Templates
      description: Lists information about created state templates. 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListStateTemplatesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException; InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - IoTAutobahnControlPlane.ListStateTemplates
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListStateTemplatesRequest'
      tags:
      - State Template
components:
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreateStateTemplateResponse:
      type: object
      properties:
        name:
          type: string
          description: The name of the state template.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the state template.
        id:
          type: string
          description: The unique ID of the state template.
    ConflictException:
      type: object
      properties:
        message:
          type: string
        resource:
          type: string
          description: The resource on which there are conflicting operations.
        resourceType:
          type: string
          description: The type of resource on which there are conflicting operations..
      required:
      - message
      - resource
      - resourceType
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the parameter field with the validation error.
        message:
          type: string
          description: A message about the validation error.
      required:
      - name
      - message
    GetStateTemplateRequest:
      type: object
      properties:
        identifier:
          type: string
          description: The unique ID of the state template.
      required:
      - identifier
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag's key.
        Value:
          type: string
          description: The tag's value.
      required:
      - Key
      - Value
    UpdateStateTemplateResponse:
      type: object
      properties:
        name:
          type: string
          description: The name of the state template.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the state template.
        id:
          type: string
          description: The unique ID of the state template.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The identifier of the resource that wasn't found.
        resourceType:
          type: string
          description: The type of resource that wasn't found.
      required:
      - message
      - resourceId
      - resourceType
    DeleteStateTemplateResponse:
      type: object
      properties:
        name:
          type: string
          description: The name of the state template.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the state template.
        id:
          type: string
          description: The unique ID of the state template.
    GetStateTemplateResponse:
      type: object
      properties:
        name:
          type: string
          description: The name of the state template.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the state template.
        description:
          type: string
          description: A brief description of the state template.
        signalCatalogArn:
          type: string
          description: The ARN of the signal catalog associated with the state template.
        stateTemplateProperties:
          type: array
          items:
            type: string
          description: A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.
        dataExtraDimensions:
          type: array
          items:
            type: string
          description: 'A list of vehicle attributes associated with the payload published on the state template''s MQTT topic. Default: An empty array'
        metadataExtraDimensions:
          type: array
          items:
            type: string
          description: 'A list of vehicle attributes to associate with user properties of the messages published on the state template''s MQTT topic. Default: An empty array'
        creationTime:
          type: string
          format: date-time
          description: The time the state template was created in seconds since epoch (January 1, 1970 at midnight UTC time).
        lastModificationTime:
          type: string
          format: date-time
          description: The time the state template was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
        id:
          type: string
          description: The unique ID of the state template.
    InvalidSignalsException:
      type: object
      properties:
        message:
          type: string
        invalidSignals:
          type: array
          items:
            $ref: '#/components/schemas/InvalidSignal'
          description: The signals which caused the exception.
    UpdateStateTemplateRequest:
      type: object
      properties:
        identifier:
          type: string
          description: The unique ID of the state template.
        description:
          type: string
          description: A brief description of the state template.
        stateTemplatePropertiesToAdd:
          type: array
          items:
            type: string
          description: Add signals from which data is collected as part of the state template.
        stateTemplatePropertiesToRemove:
          type: array
          items:
            type: string
          description: Remove signals from which data is collected as part of the state template.
        dataExtraDimensions:
          type: array
          items:
            type: string
          description: 'A list of vehicle attributes to associate with the payload published on the state template''s MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions field. Default: An empty array'
        metadataExtraDimensions:
          type: array
          items:
            type: string
          description: A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.
      required:
      - identifier
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        quotaCode:
          type: string
          description: The quota identifier of the applied throttling rules for this request.
        serviceCode:
          type: string
          description: The code for the service that couldn't be completed due to throttling.
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying the command.
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying the command.
      required:
      - message
    CreateStateTemplateRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the state template.
        description:
          type: string
          description: A brief description of the state template.
        signalCatalogArn:
          type: string
          description: The ARN of the signal catalog associated with the state template.
        stateTemplateProperties:
          type: array
          items:
            type: string
          description: A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.
        dataExtraDimensions:
          type: array
          items:
            type: string
          description: A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions field.
        metadataExtraDimensions:
          type: array
          items:
            type: string
          description: 'A list of vehicle attributes to associate with user properties of the messages published on the state template''s MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message. Default: An empty array'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Metadata that can be used to manage the state template.
      required:
      - name
      - signalCatalogArn
      - stateTemplateProperties
    InvalidSignal:
      type: object
      properties:
        name:
          type: string
          description: The name of the signal that isn't valid.
        reason:
          type: string
          description: A message about why the signal isn't valid.
    ListStateTemplatesRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: The token to retrieve the next set of results, or null if there are no more results.
        maxResults:
          type: integer
          description: The maximum number of items to return, between 1 and 100, inclusive.
        listResponseScope:
          type: string
          enum:
          - METADATA_ONLY
          description: 'When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: state template ID, Amazon Resource Name (ARN), creation time, and last modification time.'
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - unknownOperation
          - cannotParse
          - fieldValidationFailed
          - other
          description: The reason the input failed to satisfy the constraints specified by an Amazon Web Services service.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The list of fields that fail to satisfy the constraints specified by an Amazon Web Services service.
      required:
      - message
    StateTemplateSummary:
      type: object
      properties:
        name:
          type: string
          description: The name of the state template.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the state template.
        signalCatalogArn:
          type: string
          description: The Amazon Resource Name (ARN) of the signal catalog associated with the state template.
        description:
          type: string
          description: A brief description of the state template.
        creationTime:
          type: string
          format: date-time
          description: The time the state template was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
        lastModificationTime:
          type: string
          format: date-time
          description: The time the state template was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
        id:
          type: string
          description: The unique ID of the state template.
    ListStateTemplatesResponse:
      type: object
      properties:
        summaries:
          type: array
          items:
            $ref: '#/components/schemas/StateTemplateSummary'
          description: A list of information about each state template.
        nextToken:
          type: string
          description: The token to retrieve the next set of results, or null if there are no more results.
    DeleteStateTemplateRequest:
      type: object
      properties:
        identifier:
          type: string
          description: The unique ID of the state template.
      required:
      - identifier
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: iotfleetwise
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/iotfleetwise/service/2021-06-17/iotfleetwise-2021-06-17.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)