Amazon Web Services, Inc.

AWS IoT FleetWise

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…

IoT & devices#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

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 .

Endpoints 57

Vehicle

  • POSTAssociate vehicle fleet/#X-Amz-Target=IoTAutobahnControlPlane.AssociateVehicleFleetAdds, or associates, a vehicle with a fleet.
  • POSTCreate vehicle/#X-Amz-Target=IoTAutobahnControlPlane.CreateVehicleCreates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals…
  • POSTDelete vehicle/#X-Amz-Target=IoTAutobahnControlPlane.DeleteVehicleDeletes a vehicle and removes it from any campaigns.
  • POSTDisassociate vehicle fleet/#X-Amz-Target=IoTAutobahnControlPlane.DisassociateVehicleFleetRemoves, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle.
  • POSTGet vehicle/#X-Amz-Target=IoTAutobahnControlPlane.GetVehicleRetrieves information about a vehicle.
  • POSTList vehicles/#X-Amz-Target=IoTAutobahnControlPlane.ListVehiclesRetrieves a list of summaries of created vehicles. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
  • POSTUpdate vehicle/#X-Amz-Target=IoTAutobahnControlPlane.UpdateVehicleUpdates a vehicle. Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and…

Campaign

  • POSTCreate campaign/#X-Amz-Target=IoTAutobahnControlPlane.CreateCampaignCreates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how…
  • POSTDelete campaign/#X-Amz-Target=IoTAutobahnControlPlane.DeleteCampaignDeletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.
  • POSTGet campaign/#X-Amz-Target=IoTAutobahnControlPlane.GetCampaignRetrieves information about a campaign. Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web…
  • POSTList campaigns/#X-Amz-Target=IoTAutobahnControlPlane.ListCampaignsLists information about created campaigns. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
  • POSTUpdate campaign/#X-Amz-Target=IoTAutobahnControlPlane.UpdateCampaignUpdates a campaign.

Decoder manifest

  • POSTCreate decoder manifest/#X-Amz-Target=IoTAutobahnControlPlane.CreateDecoderManifestCreates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true: Every signal decoder has a unique…
  • POSTDelete decoder manifest/#X-Amz-Target=IoTAutobahnControlPlane.DeleteDecoderManifestDeletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it.
  • POSTGet decoder manifest/#X-Amz-Target=IoTAutobahnControlPlane.GetDecoderManifestRetrieves information about a created decoder manifest.
  • POSTImport decoder manifest/#X-Amz-Target=IoTAutobahnControlPlane.ImportDecoderManifestCreates a decoder manifest using your existing CAN DBC file from your local device. The CAN signal name must be unique and not repeated across CAN message…
  • POSTList decoder manifest network interfaces/#X-Amz-Target=IoTAutobahnControlPlane.ListDecoderManifestNetworkInterfacesLists the network interfaces specified in a decoder manifest. This API operation uses pagination. Specify the nextToken parameter in the request to return…
  • POSTList decoder manifest signals/#X-Amz-Target=IoTAutobahnControlPlane.ListDecoderManifestSignalsA list of information about signal decoders specified in a decoder manifest. This API operation uses pagination. Specify the nextToken parameter in the…
  • POSTList decoder manifests/#X-Amz-Target=IoTAutobahnControlPlane.ListDecoderManifestsLists decoder manifests. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
  • POSTUpdate decoder manifest/#X-Amz-Target=IoTAutobahnControlPlane.UpdateDecoderManifestUpdates a decoder manifest. A decoder manifest can only be updated when the status is DRAFT . Only ACTIVE decoder manifests can be associated with vehicles.

Fleet

  • POSTCreate fleet/#X-Amz-Target=IoTAutobahnControlPlane.CreateFleetCreates a fleet that represents a group of vehicles. You must create both a signal catalog and vehicles before you can create a fleet. For more information,…
  • POSTDelete fleet/#X-Amz-Target=IoTAutobahnControlPlane.DeleteFleetDeletes a fleet. Before you delete a fleet, all vehicles must be dissociated from the fleet. For more information, see Delete a fleet (AWS CLI) in the Amazon…
  • POSTGet fleet/#X-Amz-Target=IoTAutobahnControlPlane.GetFleetRetrieves information about a fleet.
  • POSTList fleets/#X-Amz-Target=IoTAutobahnControlPlane.ListFleetsRetrieves information for each created fleet in an Amazon Web Services account. This API operation uses pagination. Specify the nextToken parameter in the…
  • POSTUpdate fleet/#X-Amz-Target=IoTAutobahnControlPlane.UpdateFleetUpdates the description of an existing fleet.

Model manifest

  • POSTCreate model manifest/#X-Amz-Target=IoTAutobahnControlPlane.CreateModelManifestCreates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators). For more information, see Vehicle models in…
  • POSTDelete model manifest/#X-Amz-Target=IoTAutobahnControlPlane.DeleteModelManifestDeletes a vehicle model (model manifest).
  • POSTGet model manifest/#X-Amz-Target=IoTAutobahnControlPlane.GetModelManifestRetrieves information about a vehicle model (model manifest).
  • POSTList model manifest nodes/#X-Amz-Target=IoTAutobahnControlPlane.ListModelManifestNodesLists information about nodes specified in a vehicle model (model manifest). This API operation uses pagination. Specify the nextToken parameter in the…
  • POSTList model manifests/#X-Amz-Target=IoTAutobahnControlPlane.ListModelManifestsRetrieves a list of vehicle models (model manifests). This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
  • POSTUpdate model manifest/#X-Amz-Target=IoTAutobahnControlPlane.UpdateModelManifestUpdates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.

Signal catalog

  • POSTCreate signal catalog/#X-Amz-Target=IoTAutobahnControlPlane.CreateSignalCatalogCreates a collection of standardized signals that can be reused to create vehicle models.
  • POSTDelete signal catalog/#X-Amz-Target=IoTAutobahnControlPlane.DeleteSignalCatalogDeletes a signal catalog.
  • POSTGet signal catalog/#X-Amz-Target=IoTAutobahnControlPlane.GetSignalCatalogRetrieves information about a signal catalog.
  • POSTImport signal catalog/#X-Amz-Target=IoTAutobahnControlPlane.ImportSignalCatalogCreates a signal catalog using your existing VSS formatted content from your local device.
  • POSTList signal catalog nodes/#X-Amz-Target=IoTAutobahnControlPlane.ListSignalCatalogNodesLists of information about the signals (nodes) specified in a signal catalog. This API operation uses pagination. Specify the nextToken parameter in the…
  • POSTList signal catalogs/#X-Amz-Target=IoTAutobahnControlPlane.ListSignalCatalogsLists all the created signal catalogs in an Amazon Web Services account. You can use to list information about each signal (node) specified in a signal…
  • POSTUpdate signal catalog/#X-Amz-Target=IoTAutobahnControlPlane.UpdateSignalCatalogUpdates a signal catalog.

State template

  • POSTCreate state template/#X-Amz-Target=IoTAutobahnControlPlane.CreateStateTemplateCreates a state template. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon…
  • POSTDelete state template/#X-Amz-Target=IoTAutobahnControlPlane.DeleteStateTemplateDeletes a state template.
  • POSTGet state template/#X-Amz-Target=IoTAutobahnControlPlane.GetStateTemplateRetrieves information about a state template. Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see…
  • POSTList state templates/#X-Amz-Target=IoTAutobahnControlPlane.ListStateTemplatesLists information about created state templates. Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see…
  • POSTUpdate state template/#X-Amz-Target=IoTAutobahnControlPlane.UpdateStateTemplateUpdates a state template. Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services…

Fleet association

  • POSTList fleets for vehicle/#X-Amz-Target=IoTAutobahnControlPlane.ListFleetsForVehicleRetrieves a list of IDs for all fleets that the vehicle is associated with. This API operation uses pagination. Specify the nextToken parameter in the request…

Vehicle association

  • POSTList vehicles in fleet/#X-Amz-Target=IoTAutobahnControlPlane.ListVehiclesInFleetRetrieves a list of summaries of all vehicles associated with a fleet. This API operation uses pagination. Specify the nextToken parameter in the request to…
  • POSTBatch create vehicle/#X-Amz-Target=IoTAutobahnControlPlane.BatchCreateVehicleCreates a group, or batch, of vehicles. You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle. For more information, see…
  • POSTBatch update vehicle/#X-Amz-Target=IoTAutobahnControlPlane.BatchUpdateVehicleUpdates a group, or batch, of vehicles. You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle. For more information, see…
  • POSTGet encryption configuration/#X-Amz-Target=IoTAutobahnControlPlane.GetEncryptionConfigurationRetrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.
  • POSTGet logging options/#X-Amz-Target=IoTAutobahnControlPlane.GetLoggingOptionsRetrieves the logging options.
  • POSTGet register account status/#X-Amz-Target=IoTAutobahnControlPlane.GetRegisterAccountStatusRetrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT…
  • POSTGet vehicle status/#X-Amz-Target=IoTAutobahnControlPlane.GetVehicleStatusRetrieves information about the status of campaigns, decoder manifests, or state templates associated with a vehicle.
  • POSTList tags for resource/#X-Amz-Target=IoTAutobahnControlPlane.ListTagsForResourceLists the tags (metadata) you have assigned to the resource.
  • POSTPut encryption configuration/#X-Amz-Target=IoTAutobahnControlPlane.PutEncryptionConfigurationCreates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed…
  • POSTPut logging options/#X-Amz-Target=IoTAutobahnControlPlane.PutLoggingOptionsCreates or updates the logging option.
  • POSTRegister account/#X-Amz-Target=IoTAutobahnControlPlane.RegisterAccountThis API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT…
  • POSTTag resource/#X-Amz-Target=IoTAutobahnControlPlane.TagResourceAdds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
  • POSTUntag resource/#X-Amz-Target=IoTAutobahnControlPlane.UntagResourceRemoves the given tags (metadata) from the resource.

API details

Base URL
https://iotfleetwise.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
57 operations on 57 pathsPOST 57
Main resources
Decoder manifest 8Signal catalog 7Vehicle 7Model manifest 6Campaign 5Fleet 5State template 5Fleet association 1Vehicle association 1
Description format
AWS Smithy model, API version 2021-06-17

How to test the AWS IoT FleetWise in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS IoT FleetWise collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate vehicle fleet” (POST /#X-Amz-Target=IoTAutobahnControlPlane.AssociateVehicleFleet), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS IoT FleetWise?

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… It is listed under IoT & devices and has 57 endpoints.

Who publishes the AWS IoT FleetWise?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS IoT FleetWise?

Requests go to https://iotfleetwise.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS IoT FleetWise?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS IoT FleetWise have?

57 operations on 57 paths (57 POST). The largest groups are Decoder manifest, Signal catalog, Vehicle, Model manifest.

Is forking the AWS IoT FleetWise free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.