IoTFleetWiseClient

Suggest an Edit

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.

Installation

NPM
npm install @aws-sdk/client-iotfleetwise
Yarn
yarn add @aws-sdk/client-iotfleetwise
pnpm
pnpm add @aws-sdk/client-iotfleetwise

IoTFleetWiseClient Operations

Command
Summary
AssociateVehicleFleetCommand

Adds, or associates, a vehicle with a fleet.

BatchCreateVehicleCommand

Creates 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 Create multiple vehicles (AWS CLI)  in the Amazon Web Services IoT FleetWise Developer Guide.

BatchUpdateVehicleCommand

Updates 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 Update multiple vehicles (AWS CLI)  in the Amazon Web Services IoT FleetWise Developer Guide.

CreateCampaignCommand

Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles.

For more information, see Collect and transfer data with campaigns  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.

CreateDecoderManifestCommand

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.

CreateFleetCommand

Creates 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, see Fleets  in the Amazon Web Services IoT FleetWise Developer Guide.

CreateModelManifestCommand

Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).

For more information, see Vehicle models  in the Amazon Web Services IoT FleetWise Developer Guide.

CreateSignalCatalogCommand

Creates a collection of standardized signals that can be reused to create vehicle models.

CreateStateTemplateCommand

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.

CreateVehicleCommand

Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.

If you have an existing Amazon Web Services IoT thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing.

For more information, see Create a vehicle (AWS CLI)  in the Amazon Web Services IoT FleetWise Developer Guide.

DeleteCampaignCommand

Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.

DeleteDecoderManifestCommand

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

DeleteFleetCommand

Deletes 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 Web Services IoT FleetWise Developer Guide.

DeleteModelManifestCommand

Deletes a vehicle model (model manifest).

DeleteSignalCatalogCommand

Deletes a signal catalog.

DeleteStateTemplateCommand

Deletes a state template.

DeleteVehicleCommand

Deletes a vehicle and removes it from any campaigns.

DisassociateVehicleFleetCommand

Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle.

GetCampaignCommand

Retrieves information about a campaign.

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.

GetDecoderManifestCommand

Retrieves information about a created decoder manifest.

GetEncryptionConfigurationCommand

Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.

GetFleetCommand

Retrieves information about a fleet.

GetLoggingOptionsCommand

Retrieves the logging options.

GetModelManifestCommand

Retrieves information about a vehicle model (model manifest).

GetRegisterAccountStatusCommand

Retrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud.

For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise .

This API operation doesn't require input parameters.

GetSignalCatalogCommand

Retrieves information about a signal catalog.

GetStateTemplateCommand

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.

GetVehicleCommand

Retrieves information about a vehicle.

GetVehicleStatusCommand

Retrieves information about the status of campaigns, decoder manifests, or state templates associated with a vehicle.

ImportDecoderManifestCommand

Creates 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 definitions in a .dbc file.

ImportSignalCatalogCommand

Creates a signal catalog using your existing VSS formatted content from your local device.

ListCampaignsCommand

Lists information about created campaigns.

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

ListDecoderManifestNetworkInterfacesCommand

Lists the network interfaces specified in a decoder manifest.

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

ListDecoderManifestSignalsCommand

A list of information about signal decoders specified in a decoder manifest.

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

ListDecoderManifestsCommand

Lists decoder manifests.

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

ListFleetsCommand

Retrieves information for each created fleet in an Amazon Web Services account.

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

ListFleetsForVehicleCommand

Retrieves 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 to return more results.

ListModelManifestNodesCommand

Lists information about nodes specified in a vehicle model (model manifest).

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

ListModelManifestsCommand

Retrieves a list of vehicle models (model manifests).

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

ListSignalCatalogNodesCommand

Lists of information about the signals (nodes) specified in a signal catalog.

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

ListSignalCatalogsCommand

Lists 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 catalog.

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

ListStateTemplatesCommand

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.

ListTagsForResourceCommand

Lists the tags (metadata) you have assigned to the resource.

ListVehiclesCommand

Retrieves a list of summaries of created vehicles.

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

ListVehiclesInFleetCommand

Retrieves a list of summaries of all vehicles associated with a fleet.

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

PutEncryptionConfigurationCommand

Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryption  in the Amazon Web Services IoT FleetWise Developer Guide.

PutLoggingOptionsCommand

Creates or updates the logging option.

RegisterAccountCommand

This API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream metadata stored. You should then pass the data destination into the CreateCampaign  API operation.

You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the DeleteCampaign  API operation.

If you want to delete the Timestream inline policy from the service-linked role, such as to mitigate an overly permissive policy, you must first delete any existing campaigns. Then delete the service-linked role and register your account again to enable CloudWatch metrics. For more information, see DeleteServiceLinkedRole  in the Identity and Access Management API Reference.

Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise .

An Amazon Web Services account is not the same thing as a "user." An Amazon Web Services user  is an identity that you create using Identity and Access Management (IAM) and takes the form of either an IAM user  or an IAM role, both with credentials . A single Amazon Web Services account can, and typically does, contain many users and roles.

TagResourceCommand

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

UntagResourceCommand

Removes the given tags (metadata) from the resource.

UpdateCampaignCommand

Updates a campaign.

UpdateDecoderManifestCommand

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.

UpdateFleetCommand

Updates the description of an existing fleet.

UpdateModelManifestCommand

Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.

UpdateSignalCatalogCommand

Updates a signal catalog.

UpdateStateTemplateCommand

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.

UpdateVehicleCommand

Updates a vehicle.

IoTFleetWiseClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: IoTFleetWiseClientConfig