IoTFleetWise class

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.

Constructors

IoTFleetWise({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl, bool useFipsEndpoint = false, bool useDualStackEndpoint = false})
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

associateVehicleFleet({required String fleetId, required String vehicleName}) → Future<void>
Adds, or associates, a vehicle with a fleet.
batchCreateVehicle({required List<CreateVehicleRequestItem> vehicles}) → Future<BatchCreateVehicleResponse>
Creates a group, or batch, of vehicles. For more information, see Create multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
batchUpdateVehicle({required List<UpdateVehicleRequestItem> vehicles}) → Future<BatchUpdateVehicleResponse>
Updates a group, or batch, of vehicles. For more information, see Update multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createCampaign({required CollectionScheme collectionScheme, required String name, required String signalCatalogArn, required String targetArn, Compression? compression, List<DataDestinationConfig>? dataDestinationConfigs, List<String>? dataExtraDimensions, List<DataPartition>? dataPartitions, String? description, DiagnosticsMode? diagnosticsMode, DateTime? expiryTime, int? postTriggerCollectionDuration, int? priority, List<SignalInformation>? signalsToCollect, List<SignalFetchInformation>? signalsToFetch, SpoolingMode? spoolingMode, DateTime? startTime, List<Tag>? tags}) → Future<CreateCampaignResponse>
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.
createDecoderManifest({required String modelManifestArn, required String name, DefaultForUnmappedSignalsType? defaultForUnmappedSignals, String? description, List<NetworkInterface>? networkInterfaces, List<SignalDecoder>? signalDecoders, List<Tag>? tags}) → Future<CreateDecoderManifestResponse>
Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true:
createFleet({required String fleetId, required String signalCatalogArn, String? description, List<Tag>? tags}) → Future<CreateFleetResponse>
Creates a fleet that represents a group of vehicles. For more information, see Fleets in the Amazon Web Services IoT FleetWise Developer Guide.
createModelManifest({required String name, required List<String> nodes, required String signalCatalogArn, String? description, List<Tag>? tags}) → Future<CreateModelManifestResponse>
Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).
createSignalCatalog({required String name, String? description, List<Node>? nodes, List<Tag>? tags}) → Future<CreateSignalCatalogResponse>
Creates a collection of standardized signals that can be reused to create vehicle models.
createStateTemplate({required String name, required String signalCatalogArn, required List<String> stateTemplateProperties, List<String>? dataExtraDimensions, String? description, List<String>? metadataExtraDimensions, List<Tag>? tags}) → Future<CreateStateTemplateResponse>
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.
createVehicle({required String decoderManifestArn, required String modelManifestArn, required String vehicleName, VehicleAssociationBehavior? associationBehavior, Map<String, String>? attributes, List<StateTemplateAssociation>? stateTemplates, List<Tag>? tags}) → Future<CreateVehicleResponse>
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. For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
deleteCampaign({required String name}) → Future<DeleteCampaignResponse>
Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.
deleteDecoderManifest({required String name}) → Future<DeleteDecoderManifestResponse>
Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it.
deleteFleet({required String fleetId}) → Future<DeleteFleetResponse>
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.
deleteModelManifest({required String name}) → Future<DeleteModelManifestResponse>
Deletes a vehicle model (model manifest).
deleteSignalCatalog({required String name}) → Future<DeleteSignalCatalogResponse>
Deletes a signal catalog.
deleteStateTemplate({required String identifier}) → Future<DeleteStateTemplateResponse>
Deletes a state template.
deleteVehicle({required String vehicleName}) → Future<DeleteVehicleResponse>
Deletes a vehicle and removes it from any campaigns.
disassociateVehicleFleet({required String fleetId, required String vehicleName}) → Future<void>
Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle.
getCampaign({required String name}) → Future<GetCampaignResponse>
Retrieves information about a campaign.
getDecoderManifest({required String name}) → Future<GetDecoderManifestResponse>
Retrieves information about a created decoder manifest.
getEncryptionConfiguration() → Future<GetEncryptionConfigurationResponse>
Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.
getFleet({required String fleetId}) → Future<GetFleetResponse>
Retrieves information about a fleet.
getLoggingOptions() → Future<GetLoggingOptionsResponse>
Retrieves the logging options.
getModelManifest({required String name}) → Future<GetModelManifestResponse>
Retrieves information about a vehicle model (model manifest).
getRegisterAccountStatus() → Future<GetRegisterAccountStatusResponse>
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.
getSignalCatalog({required String name}) → Future<GetSignalCatalogResponse>
Retrieves information about a signal catalog.
getStateTemplate({required String identifier}) → Future<GetStateTemplateResponse>
Retrieves information about a state template.
getVehicle({required String vehicleName}) → Future<GetVehicleResponse>
Retrieves information about a vehicle.
getVehicleStatus({required String vehicleName, int? maxResults, String? nextToken}) → Future<GetVehicleStatusResponse>
Retrieves information about the status of campaigns, decoder manifests, or state templates associated with a vehicle.
importDecoderManifest({required String name, required List<NetworkFileDefinition> networkFileDefinitions}) → Future<ImportDecoderManifestResponse>
Creates a decoder manifest using your existing CAN DBC file from your local device.
importSignalCatalog({required String name, String? description, List<Tag>? tags, FormattedVss? vss}) → Future<ImportSignalCatalogResponse>
Creates a signal catalog using your existing VSS formatted content from your local device.
listCampaigns({ListResponseScope? listResponseScope, int? maxResults, String? nextToken, String? status}) → Future<ListCampaignsResponse>
Lists information about created campaigns.
listDecoderManifestNetworkInterfaces({required String name, int? maxResults, String? nextToken}) → Future<ListDecoderManifestNetworkInterfacesResponse>
Lists the network interfaces specified in a decoder manifest.
listDecoderManifests({ListResponseScope? listResponseScope, int? maxResults, String? modelManifestArn, String? nextToken}) → Future<ListDecoderManifestsResponse>
Lists decoder manifests.
listDecoderManifestSignals({required String name, int? maxResults, String? nextToken}) → Future<ListDecoderManifestSignalsResponse>
A list of information about signal decoders specified in a decoder manifest.
listFleets({ListResponseScope? listResponseScope, int? maxResults, String? nextToken}) → Future<ListFleetsResponse>
Retrieves information for each created fleet in an Amazon Web Services account.
listFleetsForVehicle({required String vehicleName, int? maxResults, String? nextToken}) → Future<ListFleetsForVehicleResponse>
Retrieves a list of IDs for all fleets that the vehicle is associated with.
listModelManifestNodes({required String name, int? maxResults, String? nextToken}) → Future<ListModelManifestNodesResponse>
Lists information about nodes specified in a vehicle model (model manifest).
listModelManifests({ListResponseScope? listResponseScope, int? maxResults, String? nextToken, String? signalCatalogArn}) → Future<ListModelManifestsResponse>
Retrieves a list of vehicle models (model manifests).
listSignalCatalogNodes({required String name, int? maxResults, String? nextToken, SignalNodeType? signalNodeType}) → Future<ListSignalCatalogNodesResponse>
Lists of information about the signals (nodes) specified in a signal catalog.
listSignalCatalogs({int? maxResults, String? nextToken}) → Future<ListSignalCatalogsResponse>
Lists all the created signal catalogs in an Amazon Web Services account.
listStateTemplates({ListResponseScope? listResponseScope, int? maxResults, String? nextToken}) → Future<ListStateTemplatesResponse>
Lists information about created state templates.
listTagsForResource({required String resourceARN}) → Future<ListTagsForResourceResponse>
Lists the tags (metadata) you have assigned to the resource.
listVehicles({List<String>? attributeNames, List<String>? attributeValues, ListResponseScope? listResponseScope, int? maxResults, String? modelManifestArn, String? nextToken}) → Future<ListVehiclesResponse>
Retrieves a list of summaries of created vehicles.
listVehiclesInFleet({required String fleetId, int? maxResults, String? nextToken}) → Future<ListVehiclesInFleetResponse>
Retrieves a list of summaries of all vehicles associated with a fleet.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putEncryptionConfiguration({required EncryptionType encryptionType, String? kmsKeyId}) → Future<PutEncryptionConfigurationResponse>
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.
putLoggingOptions({required CloudWatchLogDeliveryOptions cloudWatchLogDelivery}) → Future<void>
Creates or updates the logging option.
registerAccount({IamResources? iamResources, TimestreamResources? timestreamResources}) → Future<RegisterAccountResponse>
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.

May throw AccessDeniedException. May throw ConflictException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter iamResources : The IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.

tagResource({required String resourceARN, required List<Tag> tags}) → Future<void>
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceARN, required List<String> tagKeys}) → Future<void>
Removes the given tags (metadata) from the resource.
updateCampaign({required UpdateCampaignAction action, required String name, List<String>? dataExtraDimensions, String? description}) → Future<UpdateCampaignResponse>
Updates a campaign.
updateDecoderManifest({required String name, DefaultForUnmappedSignalsType? defaultForUnmappedSignals, String? description, List<NetworkInterface>? networkInterfacesToAdd, List<String>? networkInterfacesToRemove, List<NetworkInterface>? networkInterfacesToUpdate, List<SignalDecoder>? signalDecodersToAdd, List<String>? signalDecodersToRemove, List<SignalDecoder>? signalDecodersToUpdate, ManifestStatus? status}) → Future<UpdateDecoderManifestResponse>
Updates a decoder manifest.
updateFleet({required String fleetId, String? description}) → Future<UpdateFleetResponse>
Updates the description of an existing fleet.
updateModelManifest({required String name, String? description, List<String>? nodesToAdd, List<String>? nodesToRemove, ManifestStatus? status}) → Future<UpdateModelManifestResponse>
Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.
updateSignalCatalog({required String name, String? description, List<Node>? nodesToAdd, List<String>? nodesToRemove, List<Node>? nodesToUpdate}) → Future<UpdateSignalCatalogResponse>
Updates a signal catalog.
updateStateTemplate({required String identifier, List<String>? dataExtraDimensions, String? description, List<String>? metadataExtraDimensions, List<String>? stateTemplatePropertiesToAdd, List<String>? stateTemplatePropertiesToRemove}) → Future<UpdateStateTemplateResponse>
Updates a state template.
updateVehicle({required String vehicleName, UpdateMode? attributeUpdateMode, Map<String, String>? attributes, String? decoderManifestArn, String? modelManifestArn, List<StateTemplateAssociation>? stateTemplatesToAdd, List<String>? stateTemplatesToRemove, List<StateTemplateAssociation>? stateTemplatesToUpdate}) → Future<UpdateVehicleResponse>
Updates a vehicle.

Operators

operator ==(Object other) → bool
The equality operator.
inherited