Iotfleetwise

This page documents function available when using the Iotfleetwise module, created with @service Iotfleetwise.

Index

Documentation

Main.Iotfleetwise.associate_vehicle_fleetMethod
associate_vehicle_fleet(fleet_id, vehicle_name)
associate_vehicle_fleet(fleet_id, vehicle_name, params::Dict{String,<:Any})

Adds, or associates, a vehicle with a fleet.

Arguments

  • fleet_id: The ID of a fleet.
  • vehicle_name: The unique ID of the vehicle to associate with the fleet.
Main.Iotfleetwise.batch_create_vehicleMethod
batch_create_vehicle(vehicles)
batch_create_vehicle(vehicles, params::Dict{String,<:Any})

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.

Arguments

  • vehicles: A list of information about each vehicle to create. For more information, see the API data type.
Main.Iotfleetwise.batch_update_vehicleMethod
batch_update_vehicle(vehicles)
batch_update_vehicle(vehicles, params::Dict{String,<:Any})

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.

Arguments

  • vehicles: A list of information about the vehicles to update. For more information, see the API data type.
Main.Iotfleetwise.create_campaignMethod
create_campaign(collection_scheme, name, signal_catalog_arn, target_arn)
create_campaign(collection_scheme, name, signal_catalog_arn, target_arn, params::Dict{String,<:Any})

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.

Arguments

  • collection_scheme: The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.
  • name: The name of the campaign to create.
  • signal_catalog_arn: (Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
  • target_arn: The ARN of the vehicle or fleet to deploy a campaign to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "compression": (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If it's not specified, SNAPPY is used. Default: SNAPPY
  • "dataDestinationConfigs": The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream. Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
  • "dataExtraDimensions": (Optional) A list of vehicle attributes to associate with a campaign. Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model. Default: An empty array
  • "description": An optional description of the campaign to help identify its purpose.
  • "diagnosticsMode": (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SENDACTIVEDTCS. If it's not specified, OFF is used. Default: OFF
  • "expiryTime": (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires. Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
  • "postTriggerCollectionDuration": (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0 is used. Default: 0
  • "priority": (Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used. Default: 0
  • "signalsToCollect": (Optional) A list of information about signals to collect.
  • "spoolingMode": (Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used. Default: OFF
  • "startTime": (Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used. Default: 0
  • "tags": Metadata that can be used to manage the campaign.
Main.Iotfleetwise.create_decoder_manifestMethod
create_decoder_manifest(model_manifest_arn, name)
create_decoder_manifest(model_manifest_arn, name, params::Dict{String,<:Any})

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.

Arguments

  • model_manifest_arn: The Amazon Resource Name (ARN) of the vehicle model (model manifest).
  • name: The unique name of the decoder manifest to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A brief description of the decoder manifest.
  • "networkInterfaces": A list of information about available network interfaces.
  • "signalDecoders": A list of information about signal decoders.
  • "tags": Metadata that can be used to manage the decoder manifest.
Main.Iotfleetwise.create_fleetMethod
create_fleet(fleet_id, signal_catalog_arn)
create_fleet(fleet_id, signal_catalog_arn, params::Dict{String,<:Any})

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.

Arguments

  • fleet_id: The unique ID of the fleet to create.
  • signal_catalog_arn: The Amazon Resource Name (ARN) of a signal catalog.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A brief description of the fleet to create.
  • "tags": Metadata that can be used to manage the fleet.
Main.Iotfleetwise.create_model_manifestMethod
create_model_manifest(name, nodes, signal_catalog_arn)
create_model_manifest(name, nodes, signal_catalog_arn, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the vehicle model to create.
  • nodes: A list of nodes, which are a general abstraction of signals.
  • signal_catalog_arn: The Amazon Resource Name (ARN) of a signal catalog.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A brief description of the vehicle model.
  • "tags": Metadata that can be used to manage the vehicle model.
Main.Iotfleetwise.create_signal_catalogMethod
create_signal_catalog(name)
create_signal_catalog(name, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the signal catalog to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A brief description of the signal catalog.
  • "nodes": A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.
  • "tags": Metadata that can be used to manage the signal catalog.
Main.Iotfleetwise.create_vehicleMethod
create_vehicle(decoder_manifest_arn, model_manifest_arn, vehicle_name)
create_vehicle(decoder_manifest_arn, model_manifest_arn, vehicle_name, params::Dict{String,<:Any})

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.

Arguments

  • decoder_manifest_arn: The ARN of a decoder manifest.
  • model_manifest_arn: The Amazon Resource Name ARN of a vehicle model.
  • vehicle_name: The unique ID of the vehicle to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "associationBehavior": An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle. Default:
  • "attributes": Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2" A campaign must include the keys (attribute names) in dataExtraDimensions for them to display in Amazon Timestream.
  • "tags": Metadata that can be used to manage the vehicle.
Main.Iotfleetwise.delete_campaignMethod
delete_campaign(name)
delete_campaign(name, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the campaign to delete.
Main.Iotfleetwise.delete_decoder_manifestMethod
delete_decoder_manifest(name)
delete_decoder_manifest(name, params::Dict{String,<:Any})

Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it. If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

Arguments

  • name: The name of the decoder manifest to delete.
Main.Iotfleetwise.delete_fleetMethod
delete_fleet(fleet_id)
delete_fleet(fleet_id, params::Dict{String,<:Any})

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. If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

Arguments

  • fleet_id: The ID of the fleet to delete.
Main.Iotfleetwise.delete_model_manifestMethod
delete_model_manifest(name)
delete_model_manifest(name, params::Dict{String,<:Any})

Deletes a vehicle model (model manifest). If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

Arguments

  • name: The name of the model manifest to delete.
Main.Iotfleetwise.delete_signal_catalogMethod
delete_signal_catalog(name)
delete_signal_catalog(name, params::Dict{String,<:Any})

Deletes a signal catalog. If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

Arguments

  • name: The name of the signal catalog to delete.
Main.Iotfleetwise.delete_vehicleMethod
delete_vehicle(vehicle_name)
delete_vehicle(vehicle_name, params::Dict{String,<:Any})

Deletes a vehicle and removes it from any campaigns. If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

Arguments

  • vehicle_name: The ID of the vehicle to delete.
Main.Iotfleetwise.disassociate_vehicle_fleetMethod
disassociate_vehicle_fleet(fleet_id, vehicle_name)
disassociate_vehicle_fleet(fleet_id, vehicle_name, params::Dict{String,<:Any})

Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle. If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.

Arguments

  • fleet_id: The unique ID of a fleet.
  • vehicle_name: The unique ID of the vehicle to disassociate from the fleet.
Main.Iotfleetwise.get_campaignMethod
get_campaign(name)
get_campaign(name, params::Dict{String,<:Any})

Retrieves information about a campaign.

Arguments

  • name: The name of the campaign to retrieve information about.
Main.Iotfleetwise.get_decoder_manifestMethod
get_decoder_manifest(name)
get_decoder_manifest(name, params::Dict{String,<:Any})

Retrieves information about a created decoder manifest.

Arguments

  • name: The name of the decoder manifest to retrieve information about.
Main.Iotfleetwise.get_fleetMethod
get_fleet(fleet_id)
get_fleet(fleet_id, params::Dict{String,<:Any})

Retrieves information about a fleet.

Arguments

  • fleet_id: The ID of the fleet to retrieve information about.
Main.Iotfleetwise.get_model_manifestMethod
get_model_manifest(name)
get_model_manifest(name, params::Dict{String,<:Any})

Retrieves information about a vehicle model (model manifest).

Arguments

  • name: The name of the vehicle model to retrieve information about.
Main.Iotfleetwise.get_register_account_statusMethod
get_register_account_status()
get_register_account_status(params::Dict{String,<:Any})

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.

Main.Iotfleetwise.get_signal_catalogMethod
get_signal_catalog(name)
get_signal_catalog(name, params::Dict{String,<:Any})

Retrieves information about a signal catalog.

Arguments

  • name: The name of the signal catalog to retrieve information about.
Main.Iotfleetwise.get_vehicleMethod
get_vehicle(vehicle_name)
get_vehicle(vehicle_name, params::Dict{String,<:Any})

Retrieves information about a vehicle.

Arguments

  • vehicle_name: The ID of the vehicle to retrieve information about.
Main.Iotfleetwise.get_vehicle_statusMethod
get_vehicle_status(vehicle_name)
get_vehicle_status(vehicle_name, params::Dict{String,<:Any})

Retrieves information about the status of a vehicle with any associated campaigns.

Arguments

  • vehicle_name: The ID of the vehicle to retrieve information about.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to return, between 1 and 100, inclusive.
  • "nextToken": A pagination token for the next set of results. If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
Main.Iotfleetwise.import_decoder_manifestMethod
import_decoder_manifest(name, network_file_definitions)
import_decoder_manifest(name, network_file_definitions, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the decoder manifest to import.
  • network_file_definitions: The file to load into an Amazon Web Services account.
Main.Iotfleetwise.import_signal_catalogMethod
import_signal_catalog(name)
import_signal_catalog(name, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the signal catalog to import.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A brief description of the signal catalog.
  • "tags": Metadata that can be used to manage the signal catalog.
  • "vss": The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise language used to describe and model signals in vehicle networks.
Main.Iotfleetwise.list_campaignsMethod
list_campaigns()
list_campaigns(params::Dict{String,<:Any})

Lists information about created campaigns. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to return, between 1 and 100, inclusive.
  • "nextToken": A pagination token for the next set of results. If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
  • "status": Optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITINGFORAPPROVAL, RUNNING, or SUSPENDED.
Main.Iotfleetwise.list_decoder_manifest_network_interfacesMethod
list_decoder_manifest_network_interfaces(name)
list_decoder_manifest_network_interfaces(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the decoder manifest to list information about.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to return, between 1 and 100, inclusive.
  • "nextToken": A pagination token for the next set of results. If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
Main.Iotfleetwise.list_decoder_manifest_signalsMethod
list_decoder_manifest_signals(name)
list_decoder_manifest_signals(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the decoder manifest to list information about.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to return, between 1 and 100, inclusive.
  • "nextToken": A pagination token for the next set of results. If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
Main.Iotfleetwise.list_decoder_manifestsMethod
list_decoder_manifests()
list_decoder_manifests(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to return, between 1 and 100, inclusive.
  • "modelManifestArn": The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
  • "nextToken": A pagination token for the next set of results. If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
Main.Iotfleetwise.list_fleetsMethod
list_fleets()
list_fleets(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to return, between 1 and 100, inclusive.
  • "nextToken": A pagination token for the next set of results. If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
Main.Iotfleetwise.list_fleets_for_vehicleMethod
list_fleets_for_vehicle(vehicle_name)
list_fleets_for_vehicle(vehicle_name, params::Dict{String,<:Any})

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.

Arguments

  • vehicle_name: The ID of the vehicle to retrieve information about.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to return, between 1 and 100, inclusive.
  • "nextToken": A pagination token for the next set of results. If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
Main.Iotfleetwise.list_model_manifest_nodesMethod
list_model_manifest_nodes(name)
list_model_manifest_nodes(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the vehicle model to list information about.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to return, between 1 and 100, inclusive.
  • "nextToken": A pagination token for the next set of results. If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
Main.Iotfleetwise.list_model_manifestsMethod
list_model_manifests()
list_model_manifests(params::Dict{String,<:Any})

Retrieves a list of vehicle models (model manifests). This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to return, between 1 and 100, inclusive.
  • "nextToken": A pagination token for the next set of results. If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
  • "signalCatalogArn": The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned.
Main.Iotfleetwise.list_signal_catalog_nodesMethod
list_signal_catalog_nodes(name)
list_signal_catalog_nodes(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the signal catalog to list information about.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to return, between 1 and 100, inclusive.
  • "nextToken": A pagination token for the next set of results. If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
Main.Iotfleetwise.list_signal_catalogsMethod
list_signal_catalogs()
list_signal_catalogs(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to return, between 1 and 100, inclusive.
  • "nextToken": A pagination token for the next set of results. If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
Main.Iotfleetwise.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The ARN of the resource.
Main.Iotfleetwise.list_vehiclesMethod
list_vehicles()
list_vehicles(params::Dict{String,<:Any})

Retrieves a list of summaries of created vehicles. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to return, between 1 and 100, inclusive.
  • "modelManifestArn": The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional parameter to list only the vehicles created from a certain vehicle model.
  • "nextToken": A pagination token for the next set of results. If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
Main.Iotfleetwise.list_vehicles_in_fleetMethod
list_vehicles_in_fleet(fleet_id)
list_vehicles_in_fleet(fleet_id, params::Dict{String,<:Any})

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.

Arguments

  • fleet_id: The ID of a fleet.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to return, between 1 and 100, inclusive.
  • "nextToken": A pagination token for the next set of results. If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
Main.Iotfleetwise.put_logging_optionsMethod
put_logging_options(cloud_watch_log_delivery)
put_logging_options(cloud_watch_log_delivery, params::Dict{String,<:Any})

Creates or updates the logging option.

Arguments

  • cloud_watch_log_delivery: Creates or updates the log delivery option to Amazon CloudWatch Logs.
Main.Iotfleetwise.register_accountMethod
register_account()
register_account(params::Dict{String,<:Any})

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. &lt;p&gt;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 &lt;a href=&quot;https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html&q uot;&gt;Setting up Amazon Web Services IoT FleetWise&lt;/a&gt;. &lt;/p&gt; &lt;note&gt; &lt;p&gt;An Amazon Web Services account is &lt;b&gt;not&lt;/b&gt; the same thing as a &quot;user.&quot; An &lt;a href=&quot;https://docs.aws.amazon.com/IAM/latest/UserGuide/introductionidentity-management .html#intro-identity-users&quot;&gt;Amazon Web Services user&lt;/a&gt; is an identity that you create using Identity and Access Management (IAM) and takes the form of either an &lt;a href=&quot;https://docs.aws.amazon.com/IAM/latest/UserGuide/idusers.html&quot;&gt;IAM user&lt;/a&gt; or an &lt;a href=&quot;https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html&quot;&gt;IAM role, both with credentials&lt;/a&gt;. A single Amazon Web Services account can, and typically does, contain many users and roles.&lt;/p&gt; &lt;/note&gt;

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "iamResources": The IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.
  • "timestreamResources":
Main.Iotfleetwise.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The ARN of the resource.
  • tags: The new or modified tags for the resource.
Main.Iotfleetwise.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes the given tags (metadata) from the resource.

Arguments

  • resource_arn: The ARN of the resource.
  • tag_keys: A list of the keys of the tags to be removed from the resource.
Main.Iotfleetwise.update_campaignMethod
update_campaign(action, name)
update_campaign(action, name, params::Dict{String,<:Any})

Updates a campaign.

Arguments

  • action: Specifies how to update a campaign. The action can be one of the following: APPROVE - To approve delivering a data collection scheme to vehicles. SUSPEND - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data. RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data. UPDATE - To update a campaign.
  • name: The name of the campaign to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "dataExtraDimensions": A list of vehicle attributes to associate with a signal. Default: An empty array
  • "description": The description of the campaign.
Main.Iotfleetwise.update_decoder_manifestMethod
update_decoder_manifest(name)
update_decoder_manifest(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the decoder manifest to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A brief description of the decoder manifest to update.
  • "networkInterfacesToAdd": A list of information about the network interfaces to add to the decoder manifest.
  • "networkInterfacesToRemove": A list of network interfaces to remove from the decoder manifest.
  • "networkInterfacesToUpdate": A list of information about the network interfaces to update in the decoder manifest.
  • "signalDecodersToAdd": A list of information about decoding additional signals to add to the decoder manifest.
  • "signalDecodersToRemove": A list of signal decoders to remove from the decoder manifest.
  • "signalDecodersToUpdate": A list of updated information about decoding signals to update in the decoder manifest.
  • "status": The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.
Main.Iotfleetwise.update_fleetMethod
update_fleet(fleet_id)
update_fleet(fleet_id, params::Dict{String,<:Any})

Updates the description of an existing fleet. If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty HTTP body.

Arguments

  • fleet_id: The ID of the fleet to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": An updated description of the fleet.
Main.Iotfleetwise.update_model_manifestMethod
update_model_manifest(name)
update_model_manifest(name, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the vehicle model to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A brief description of the vehicle model.
  • "nodesToAdd": A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to add to the vehicle model.
  • "nodesToRemove": A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to remove from the vehicle model.
  • "status": The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. If the status is DRAFT, you can edit the vehicle model.
Main.Iotfleetwise.update_signal_catalogMethod
update_signal_catalog(name)
update_signal_catalog(name, params::Dict{String,<:Any})

Updates a signal catalog.

Arguments

  • name: The name of the signal catalog to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A brief description of the signal catalog to update.
  • "nodesToAdd": A list of information about nodes to add to the signal catalog.
  • "nodesToRemove": A list of fullyQualifiedName of nodes to remove from the signal catalog.
  • "nodesToUpdate": A list of information about nodes to update in the signal catalog.
Main.Iotfleetwise.update_vehicleMethod
update_vehicle(vehicle_name)
update_vehicle(vehicle_name, params::Dict{String,<:Any})

Updates a vehicle.

Arguments

  • vehicle_name: The unique ID of the vehicle to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "attributeUpdateMode": The method the specified attributes will update the existing attributes on the vehicle. UseOverwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes. This is required if attributes are present in the input.
  • "attributes": Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"
  • "decoderManifestArn": The ARN of the decoder manifest associated with this vehicle.
  • "modelManifestArn": The ARN of a vehicle model (model manifest) associated with the vehicle.