aws-elixir

View Source AWS.IoTFleetWise (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

associate_vehicle_fleet(client, input, options \\ [])

Adds, or associates, a vehicle with a fleet.

batch_create_vehicle(client, input, options \\ [])

Creates a group, or batch, of vehicles.

batch_update_vehicle(client, input, options \\ [])

Updates a group, or batch, of vehicles.

create_campaign(client, input, options \\ [])

Creates an orchestration of data collection rules.

create_decoder_manifest(client, input, options \\ [])

Creates the decoder manifest associated with a model manifest.

create_fleet(client, input, options \\ [])

Creates a fleet that represents a group of vehicles.

create_model_manifest(client, input, options \\ [])

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

create_signal_catalog(client, input, options \\ [])

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

create_state_template(client, input, options \\ [])

Creates a state template.

create_vehicle(client, input, options \\ [])

Creates a vehicle, which is an instance of a vehicle model (model manifest).

delete_campaign(client, input, options \\ [])

Deletes a data collection campaign.

delete_decoder_manifest(client, input, options \\ [])

Deletes a decoder manifest.

delete_fleet(client, input, options \\ [])

Deletes a fleet.

delete_model_manifest(client, input, options \\ [])

Deletes a vehicle model (model manifest).

delete_signal_catalog(client, input, options \\ [])

Deletes a signal catalog.

delete_state_template(client, input, options \\ [])

Deletes a state template.

delete_vehicle(client, input, options \\ [])

Deletes a vehicle and removes it from any campaigns.

disassociate_vehicle_fleet(client, input, options \\ [])

Removes, or disassociates, a vehicle from a fleet.

get_campaign(client, input, options \\ [])

Retrieves information about a campaign.

get_decoder_manifest(client, input, options \\ [])

Retrieves information about a created decoder manifest.

get_encryption_configuration(client, input, options \\ [])

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

get_fleet(client, input, options \\ [])

Retrieves information about a fleet.

get_logging_options(client, input, options \\ [])

Retrieves the logging options.

get_model_manifest(client, input, options \\ [])

Retrieves information about a vehicle model (model manifest).

get_register_account_status(client, input, options \\ [])

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.

get_signal_catalog(client, input, options \\ [])

Retrieves information about a signal catalog.

get_state_template(client, input, options \\ [])

Retrieves information about a state template.

get_vehicle(client, input, options \\ [])

Retrieves information about a vehicle.

get_vehicle_status(client, input, options \\ [])

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

import_decoder_manifest(client, input, options \\ [])

Creates a decoder manifest using your existing CAN DBC file from your local device.

import_signal_catalog(client, input, options \\ [])

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

list_campaigns(client, input, options \\ [])

Lists information about created campaigns.

list_decoder_manifest_network_interfaces(client, input, options \\ [])

Lists the network interfaces specified in a decoder manifest.

list_decoder_manifest_signals(client, input, options \\ [])

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

list_decoder_manifests(client, input, options \\ [])

Lists decoder manifests.

list_fleets(client, input, options \\ [])

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

list_fleets_for_vehicle(client, input, options \\ [])

Retrieves a list of IDs for all fleets that the vehicle is associated with.

list_model_manifest_nodes(client, input, options \\ [])

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

list_model_manifests(client, input, options \\ [])

Retrieves a list of vehicle models (model manifests).

list_signal_catalog_nodes(client, input, options \\ [])

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

list_signal_catalogs(client, input, options \\ [])

Lists all the created signal catalogs in an Amazon Web Services account.

list_state_templates(client, input, options \\ [])

Lists information about created state templates.

list_tags_for_resource(client, input, options \\ [])

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

list_vehicles(client, input, options \\ [])

Retrieves a list of summaries of created vehicles.

list_vehicles_in_fleet(client, input, options \\ [])

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

metadata()
put_encryption_configuration(client, input, options \\ [])

Creates or updates the encryption configuration.

put_logging_options(client, input, options \\ [])

Creates or updates the logging option.

register_account(client, input, options \\ [])

This API operation contains deprecated parameters.

tag_resource(client, input, options \\ [])

Adds to or modifies the tags of the given resource.

untag_resource(client, input, options \\ [])

Removes the given tags (metadata) from the resource.

update_campaign(client, input, options \\ [])

Updates a campaign.

update_decoder_manifest(client, input, options \\ [])

Updates a decoder manifest.

update_fleet(client, input, options \\ [])

Updates the description of an existing fleet.

update_model_manifest(client, input, options \\ [])

Updates a vehicle model (model manifest).

update_signal_catalog(client, input, options \\ [])

Updates a signal catalog.

update_state_template(client, input, options \\ [])

Updates a state template.

update_vehicle(client, input, options \\ [])

Updates a vehicle.

Link to this section Functions

Link to this function

associate_vehicle_fleet(client, input, options \\ [])

View Source

Adds, or associates, a vehicle with a fleet.

Link to this function

batch_create_vehicle(client, input, options \\ [])

View Source

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.

Link to this function

batch_update_vehicle(client, input, options \\ [])

View Source

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.

Link to this function

create_campaign(client, input, options \\ [])

View Source

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.

Link to this function

create_decoder_manifest(client, input, options \\ [])

View Source

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.

Link to this function

create_fleet(client, input, options \\ [])

View Source

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.

Link to this function

create_model_manifest(client, input, options \\ [])

View Source

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.

Link to this function

create_signal_catalog(client, input, options \\ [])

View Source

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

Link to this function

create_state_template(client, input, options \\ [])

View Source

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.

Link to this function

create_vehicle(client, input, options \\ [])

View Source

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.

Link to this function

delete_campaign(client, input, options \\ [])

View Source

Deletes a data collection campaign.

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

Link to this function

delete_decoder_manifest(client, input, options \\ [])

View Source

Deletes a decoder manifest.

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

Link to this function

delete_fleet(client, input, options \\ [])

View Source

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.

Link to this function

delete_model_manifest(client, input, options \\ [])

View Source

Deletes a vehicle model (model manifest).

Link to this function

delete_signal_catalog(client, input, options \\ [])

View Source

Deletes a signal catalog.

Link to this function

delete_state_template(client, input, options \\ [])

View Source

Deletes a state template.

Link to this function

delete_vehicle(client, input, options \\ [])

View Source

Deletes a vehicle and removes it from any campaigns.

Link to this function

disassociate_vehicle_fleet(client, input, options \\ [])

View Source

Removes, or disassociates, a vehicle from a fleet.

Disassociating a vehicle from a fleet doesn't delete the vehicle.

Link to this function

get_campaign(client, input, options \\ [])

View Source

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.

Link to this function

get_decoder_manifest(client, input, options \\ [])

View Source

Retrieves information about a created decoder manifest.

Link to this function

get_encryption_configuration(client, input, options \\ [])

View Source

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

Link to this function

get_fleet(client, input, options \\ [])

View Source

Retrieves information about a fleet.

Link to this function

get_logging_options(client, input, options \\ [])

View Source

Retrieves the logging options.

Link to this function

get_model_manifest(client, input, options \\ [])

View Source

Retrieves information about a vehicle model (model manifest).

Link to this function

get_register_account_status(client, input, options \\ [])

View Source

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.

Link to this function

get_signal_catalog(client, input, options \\ [])

View Source

Retrieves information about a signal catalog.

Link to this function

get_state_template(client, input, options \\ [])

View Source

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.

Link to this function

get_vehicle(client, input, options \\ [])

View Source

Retrieves information about a vehicle.

Link to this function

get_vehicle_status(client, input, options \\ [])

View Source

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

Link to this function

import_decoder_manifest(client, input, options \\ [])

View Source

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.

Link to this function

import_signal_catalog(client, input, options \\ [])

View Source

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

Link to this function

list_campaigns(client, input, options \\ [])

View Source

Lists information about created campaigns.

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

Link to this function

list_decoder_manifest_network_interfaces(client, input, options \\ [])

View Source

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.

Link to this function

list_decoder_manifest_signals(client, input, options \\ [])

View Source

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.

Link to this function

list_decoder_manifests(client, input, options \\ [])

View Source

Lists decoder manifests.

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

Link to this function

list_fleets(client, input, options \\ [])

View Source

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.

Link to this function

list_fleets_for_vehicle(client, input, options \\ [])

View Source

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.

Link to this function

list_model_manifest_nodes(client, input, options \\ [])

View Source

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.

Link to this function

list_model_manifests(client, input, options \\ [])

View Source

Retrieves a list of vehicle models (model manifests).

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

Link to this function

list_signal_catalog_nodes(client, input, options \\ [])

View Source

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.

Link to this function

list_signal_catalogs(client, input, options \\ [])

View Source

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.

Link to this function

list_state_templates(client, input, options \\ [])

View Source

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.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

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

Link to this function

list_vehicles(client, input, options \\ [])

View Source

Retrieves a list of summaries of created vehicles.

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

Link to this function

list_vehicles_in_fleet(client, input, options \\ [])

View Source

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.

Link to this function

metadata()

View Source
Link to this function

put_encryption_configuration(client, input, options \\ [])

View Source

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.

Link to this function

put_logging_options(client, input, options \\ [])

View Source

Creates or updates the logging option.

Link to this function

register_account(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds to or modifies the tags of the given resource.

Tags are metadata which can be used to manage a resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes the given tags (metadata) from the resource.

Link to this function

update_campaign(client, input, options \\ [])

View Source

Updates a campaign.

Link to this function

update_decoder_manifest(client, input, options \\ [])

View Source

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.

Link to this function

update_fleet(client, input, options \\ [])

View Source

Updates the description of an existing fleet.

Link to this function

update_model_manifest(client, input, options \\ [])

View Source

Updates a vehicle model (model manifest).

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

Link to this function

update_signal_catalog(client, input, options \\ [])

View Source

Updates a signal catalog.

Link to this function

update_state_template(client, input, options \\ [])

View Source

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.

Link to this function

update_vehicle(client, input, options \\ [])

View Source

Updates a vehicle.