iotfleetwise/aws.sdk.kotlin.services.iotfleetwise.model

Package-level declarations

Types

class AccessDeniedException : IotFleetWiseException

You don't have sufficient permission to perform this action.

A signal that represents a vehicle device such as the engine, heater, and door locks. Data from an actuator reports the state of a certain vehicle device.

AssociateVehicleFleetRequest

class AssociateVehicleFleetRequest

AssociateVehicleFleetResponse

class AssociateVehicleFleetResponse

Attribute

class Attribute

A signal that represents static information about the vehicle, such as engine type or manufacturing date.

BatchCreateVehicleRequest

class BatchCreateVehicleRequest

BatchCreateVehicleResponse

class BatchCreateVehicleResponse

BatchUpdateVehicleRequest

class BatchUpdateVehicleRequest

BatchUpdateVehicleResponse

class BatchUpdateVehicleResponse

Branch

class Branch

A group of signals that are defined in a hierarchical structure.

CampaignStatus

sealed class CampaignStatus

CampaignSummary

class CampaignSummary

Information about a campaign.

CanDbcDefinition

class CanDbcDefinition

Configurations used to create a decoder manifest.

CanInterface

class CanInterface

A single controller area network (CAN) device interface.

CanSignal

class CanSignal

Information about a single controller area network (CAN) signal and the messages it receives and transmits.

CloudWatchLogDeliveryOptions

class CloudWatchLogDeliveryOptions

The log delivery option to send data to Amazon CloudWatch Logs.

CollectionScheme

sealed class CollectionScheme

Specifies what data to collect and how often or when to collect it.

Compression

sealed class Compression

ConditionBasedCollectionScheme

class ConditionBasedCollectionScheme

Information about a collection scheme that uses a simple logical expression to recognize what data to collect.

ConditionBasedSignalFetchConfig

class ConditionBasedSignalFetchConfig

Specifies the condition under which a signal fetch occurs.

ConflictException

class ConflictException : IotFleetWiseException

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

CreateCampaignRequest

class CreateCampaignRequest

CreateCampaignResponse

class CreateCampaignResponse

CreateDecoderManifestRequest

class CreateDecoderManifestRequest

CreateDecoderManifestResponse

class CreateDecoderManifestResponse

CreateFleetRequest

class CreateFleetRequest

CreateFleetResponse

class CreateFleetResponse

CreateModelManifestRequest

class CreateModelManifestRequest

CreateModelManifestResponse

class CreateModelManifestResponse

CreateSignalCatalogRequest

class CreateSignalCatalogRequest

CreateSignalCatalogResponse

class CreateSignalCatalogResponse

CreateStateTemplateRequest

class CreateStateTemplateRequest

CreateStateTemplateResponse

class CreateStateTemplateResponse

CreateVehicleError

class CreateVehicleError

An HTTP error resulting from creating a vehicle.

CreateVehicleRequest

class CreateVehicleRequest

CreateVehicleRequestItem

class CreateVehicleRequestItem

Information about the vehicle to create.

CreateVehicleResponse

class CreateVehicleResponse

CreateVehicleResponseItem

class CreateVehicleResponseItem

Information about a created vehicle.

CustomDecodingInterface

class CustomDecodingInterface

Represents a custom network interface as defined by the customer.

CustomDecodingSignal

class CustomDecodingSignal

Information about signals using a custom decoding protocol as defined by the customer.

CustomProperty

class CustomProperty

Represents a member of the complex data structure. The data type of the property can be either primitive or another struct.

CustomStruct

class CustomStruct

The custom structure represents a complex or higher-order data structure.

DataDestinationConfig

sealed class DataDestinationConfig

The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.

DataFormat

sealed class DataFormat

DataPartition

class DataPartition

The configuration for signal data storage and upload options. You can only specify these options when the campaign's spooling mode is TO_DISK.

DataPartitionStorageOptions

class DataPartitionStorageOptions

Size, time, and location options for the data partition.

DataPartitionUploadOptions

class DataPartitionUploadOptions

The upload options for the data partition. If upload options are specified, you must also specify storage options. See DataPartitionStorageOptions.

DecoderManifestSummary

class DecoderManifestSummary

Information about a created decoder manifest. You can use the API operation to return this information about multiple decoder manifests.

DecoderManifestValidationException

class DecoderManifestValidationException : IotFleetWiseException

The request couldn't be completed because it contains signal decoders with one or more validation errors.

DefaultForUnmappedSignalsType

sealed class DefaultForUnmappedSignalsType

DeleteCampaignRequest

class DeleteCampaignRequest

DeleteCampaignResponse

class DeleteCampaignResponse

DeleteDecoderManifestRequest

class DeleteDecoderManifestRequest

DeleteDecoderManifestResponse

class DeleteDecoderManifestResponse

DeleteFleetRequest

class DeleteFleetRequest

DeleteFleetResponse

class DeleteFleetResponse

DeleteModelManifestRequest

class DeleteModelManifestRequest

DeleteModelManifestResponse

class DeleteModelManifestResponse

DeleteSignalCatalogRequest

class DeleteSignalCatalogRequest

DeleteSignalCatalogResponse

class DeleteSignalCatalogResponse

DeleteStateTemplateRequest

class DeleteStateTemplateRequest

DeleteStateTemplateResponse

class DeleteStateTemplateResponse

DeleteVehicleRequest

class DeleteVehicleRequest

DeleteVehicleResponse

class DeleteVehicleResponse

DiagnosticsMode

sealed class DiagnosticsMode

DisassociateVehicleFleetRequest

class DisassociateVehicleFleetRequest

DisassociateVehicleFleetResponse

class DisassociateVehicleFleetResponse

EncryptionStatus

sealed class EncryptionStatus

EncryptionType

sealed class EncryptionType

FleetSummary

class FleetSummary

Information about a fleet.

FormattedVss

sealed class FormattedVss

Vehicle Signal Specification (VSS) is a precise language used to describe and model signals in vehicle networks. The JSON file collects signal specificiations in a VSS format.

GetCampaignRequest

class GetCampaignRequest

GetCampaignResponse

class GetCampaignResponse

GetDecoderManifestRequest

class GetDecoderManifestRequest

GetDecoderManifestResponse

class GetDecoderManifestResponse

GetEncryptionConfigurationRequest

class GetEncryptionConfigurationRequest

GetEncryptionConfigurationResponse

class GetEncryptionConfigurationResponse

GetFleetRequest

class GetFleetRequest

GetFleetResponse

class GetFleetResponse

GetLoggingOptionsRequest

class GetLoggingOptionsRequest

GetLoggingOptionsResponse

class GetLoggingOptionsResponse

GetModelManifestRequest

class GetModelManifestRequest

GetModelManifestResponse

class GetModelManifestResponse

GetRegisterAccountStatusRequest

class GetRegisterAccountStatusRequest

GetRegisterAccountStatusResponse

class GetRegisterAccountStatusResponse

GetSignalCatalogRequest

class GetSignalCatalogRequest

GetSignalCatalogResponse

class GetSignalCatalogResponse

GetStateTemplateRequest

class GetStateTemplateRequest

GetStateTemplateResponse

class GetStateTemplateResponse

GetVehicleRequest

class GetVehicleRequest

GetVehicleResponse

class GetVehicleResponse

GetVehicleStatusRequest

class GetVehicleStatusRequest

GetVehicleStatusResponse

class GetVehicleStatusResponse

IamRegistrationResponse

class IamRegistrationResponse

Information about registering an Identity and Access Management (IAM) resource so Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to Amazon Timestream.

IamResources

class IamResources

The IAM resource that enables Amazon Web Services IoT FleetWise edge agent software to send data to Amazon Timestream.

ImportDecoderManifestRequest

class ImportDecoderManifestRequest

ImportDecoderManifestResponse

class ImportDecoderManifestResponse

ImportSignalCatalogRequest

class ImportSignalCatalogRequest

ImportSignalCatalogResponse

class ImportSignalCatalogResponse

InternalServerException

class InternalServerException : IotFleetWiseException

The request couldn't be completed because the server temporarily failed.

InvalidNetworkInterface

class InvalidNetworkInterface

A reason a vehicle network interface isn't valid.

InvalidNodeException

class InvalidNodeException : IotFleetWiseException

The specified node type doesn't match the expected node type for a node. You can specify the node type as branch, sensor, actuator, or attribute.

InvalidSignal

class InvalidSignal

A reason that a signal isn't valid.

InvalidSignalDecoder

class InvalidSignalDecoder

A reason that a signal decoder isn't valid.

InvalidSignalsException

class InvalidSignalsException : IotFleetWiseException

The request couldn't be completed because it contains signals that aren't valid.

IotFleetWiseException

open class IotFleetWiseException : AwsServiceException

Base class for all service related exceptions thrown by the IotFleetWise client

LimitExceededException

class LimitExceededException : IotFleetWiseException

A service quota was exceeded.

ListCampaignsRequest

class ListCampaignsRequest

ListCampaignsResponse

class ListCampaignsResponse

ListDecoderManifestNetworkInterfacesRequest

class ListDecoderManifestNetworkInterfacesRequest

ListDecoderManifestNetworkInterfacesResponse

class ListDecoderManifestNetworkInterfacesResponse

ListDecoderManifestSignalsRequest

class ListDecoderManifestSignalsRequest

ListDecoderManifestSignalsResponse

class ListDecoderManifestSignalsResponse

ListDecoderManifestsRequest

class ListDecoderManifestsRequest

ListDecoderManifestsResponse

class ListDecoderManifestsResponse

ListFleetsForVehicleRequest

class ListFleetsForVehicleRequest

ListFleetsForVehicleResponse

class ListFleetsForVehicleResponse

ListFleetsRequest

class ListFleetsRequest

ListFleetsResponse

class ListFleetsResponse

ListModelManifestNodesRequest

class ListModelManifestNodesRequest

ListModelManifestNodesResponse

class ListModelManifestNodesResponse

ListModelManifestsRequest

class ListModelManifestsRequest

ListModelManifestsResponse

class ListModelManifestsResponse

ListResponseScope

sealed class ListResponseScope

ListSignalCatalogNodesRequest

class ListSignalCatalogNodesRequest

ListSignalCatalogNodesResponse

class ListSignalCatalogNodesResponse

ListSignalCatalogsRequest

class ListSignalCatalogsRequest

ListSignalCatalogsResponse

class ListSignalCatalogsResponse

ListStateTemplatesRequest

class ListStateTemplatesRequest

ListStateTemplatesResponse

class ListStateTemplatesResponse

ListTagsForResourceRequest

class ListTagsForResourceRequest

ListTagsForResourceResponse

class ListTagsForResourceResponse

ListVehiclesInFleetRequest

class ListVehiclesInFleetRequest

ListVehiclesInFleetResponse

class ListVehiclesInFleetResponse

ListVehiclesRequest

class ListVehiclesRequest

ListVehiclesResponse

class ListVehiclesResponse

LogType

sealed class LogType

ManifestStatus

sealed class ManifestStatus

MessageSignal

class MessageSignal

The decoding information for a specific message which support higher order data types.

ModelManifestSummary

class ModelManifestSummary

Information about a vehicle model (model manifest). You can use the API operation to return this information about multiple vehicle models.

MqttTopicConfig

class MqttTopicConfig

The MQTT topic to which the Amazon Web Services IoT FleetWise campaign routes data. For more information, see Device communication protocols in the Amazon Web Services IoT Core Developer Guide.

NetworkFileDefinition

sealed class NetworkFileDefinition

Specifications for defining a vehicle network.

NetworkInterface

class NetworkInterface

Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node.

NetworkInterfaceFailureReason

sealed class NetworkInterfaceFailureReason

NetworkInterfaceType

sealed class NetworkInterfaceType

Node

sealed class Node

A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.

NodeCounts

class NodeCounts

Information about the number of nodes and node types in a vehicle network.

NodeDataEncoding

sealed class NodeDataEncoding

NodeDataType

sealed class NodeDataType

ObdInterface

class ObdInterface

A network interface that specifies the on-board diagnostic (OBD) II network protocol.

ObdSignal

class ObdSignal

Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.

OnChangeStateTemplateUpdateStrategy

class OnChangeStateTemplateUpdateStrategy

Vehicles associated with the state template will stream telemetry data when there is a change.

PeriodicStateTemplateUpdateStrategy

class PeriodicStateTemplateUpdateStrategy

Vehicles associated with the state template will stream telemetry data during a specified time period.

PrimitiveMessageDefinition

sealed class PrimitiveMessageDefinition

Represents a primitive type node of the complex data structure.

PutEncryptionConfigurationRequest

class PutEncryptionConfigurationRequest

PutEncryptionConfigurationResponse

class PutEncryptionConfigurationResponse

PutLoggingOptionsRequest

class PutLoggingOptionsRequest

PutLoggingOptionsResponse

class PutLoggingOptionsResponse

RegisterAccountRequest

class RegisterAccountRequest

RegisterAccountResponse

class RegisterAccountResponse

RegistrationStatus

sealed class RegistrationStatus

ResourceNotFoundException

class ResourceNotFoundException : IotFleetWiseException

The resource wasn't found.

Ros2PrimitiveMessageDefinition

class Ros2PrimitiveMessageDefinition

Represents a ROS 2 compliant primitive type message of the complex data structure.

Ros2PrimitiveType

sealed class Ros2PrimitiveType

S3Config

class S3Config

The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data. Amazon S3 is an object storage service that stores data as objects within buckets. For more information, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.

Sensor

class Sensor

An input component that reports the environmental condition of a vehicle.

SignalCatalogSummary

class SignalCatalogSummary

Information about a collection of standardized signals, which can be attributes, branches, sensors, or actuators.

SignalDecoder

class SignalDecoder

Information about a signal decoder.

SignalDecoderFailureReason

sealed class SignalDecoderFailureReason

SignalDecoderType

sealed class SignalDecoderType

SignalFetchConfig

sealed class SignalFetchConfig

The configuration of the signal fetch operation.

SignalFetchInformation

class SignalFetchInformation

Information about the signal to be fetched.

SignalInformation

class SignalInformation

Information about a signal.

SignalNodeType

sealed class SignalNodeType

SignalValueType

sealed class SignalValueType

SpoolingMode

sealed class SpoolingMode

StateTemplateAssociation

class StateTemplateAssociation

The state template associated with a vehicle. 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.

StateTemplateSummary

class StateTemplateSummary

Information about a state template.

StateTemplateUpdateStrategy

sealed class StateTemplateUpdateStrategy

The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an onChange or periodic update strategy.

StorageCompressionFormat

sealed class StorageCompressionFormat

StorageMaximumSize

class StorageMaximumSize

The maximum storage size for the data partition.

StorageMaximumSizeUnit

sealed class StorageMaximumSizeUnit

StorageMinimumTimeToLive

class StorageMinimumTimeToLive

Information about the minimum amount of time that data will be kept.

StorageMinimumTimeToLiveUnit

sealed class StorageMinimumTimeToLiveUnit

StructuredMessage

sealed class StructuredMessage

The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.

StructuredMessageFieldNameAndDataTypePair

class StructuredMessageFieldNameAndDataTypePair

Represents a StructureMessageName to DataType map element.

StructuredMessageListDefinition

class StructuredMessageListDefinition

Represents a list type node of the complex data structure.

StructuredMessageListType

sealed class StructuredMessageListType

Tag

class Tag

A set of key/value pairs that are used to manage the resource.

TagResourceRequest

class TagResourceRequest

TagResourceResponse

class TagResourceResponse

ThrottlingException

class ThrottlingException : IotFleetWiseException

The request couldn't be completed due to throttling.

TimeBasedCollectionScheme

class TimeBasedCollectionScheme

Information about a collection scheme that uses a time period to decide how often to collect data.

TimeBasedSignalFetchConfig

class TimeBasedSignalFetchConfig

Used to configure a frequency-based vehicle signal fetch.

TimePeriod

class TimePeriod

The length of time between state template updates.

TimestreamConfig

class TimestreamConfig

The Amazon Timestream table where the Amazon Web Services IoT FleetWise campaign sends data. Timestream stores and organizes data to optimize query processing time and to reduce storage costs. For more information, see Data modeling in the Amazon Timestream Developer Guide.

TimestreamRegistrationResponse

class TimestreamRegistrationResponse

Information about the registered Amazon Timestream resources or errors, if any.

TimestreamResources

class TimestreamResources

The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.

TimeUnit

sealed class TimeUnit

TriggerMode

sealed class TriggerMode

UntagResourceRequest

class UntagResourceRequest