Module: Aws::IoTFleetWise::Types

Defined in:
gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb

Defined Under Namespace

Classes: AccessDeniedException, Actuator, AssociateVehicleFleetRequest, AssociateVehicleFleetResponse, Attribute, BatchCreateVehicleRequest, BatchCreateVehicleResponse, BatchUpdateVehicleRequest, BatchUpdateVehicleResponse, Branch, CampaignSummary, CanDbcDefinition, CanInterface, CanSignal, CloudWatchLogDeliveryOptions, CollectionScheme, ConditionBasedCollectionScheme, ConditionBasedSignalFetchConfig, ConflictException, CreateCampaignRequest, CreateCampaignResponse, CreateDecoderManifestRequest, CreateDecoderManifestResponse, CreateFleetRequest, CreateFleetResponse, CreateModelManifestRequest, CreateModelManifestResponse, CreateSignalCatalogRequest, CreateSignalCatalogResponse, CreateStateTemplateRequest, CreateStateTemplateResponse, CreateVehicleError, CreateVehicleRequest, CreateVehicleRequestItem, CreateVehicleResponse, CreateVehicleResponseItem, CustomDecodingInterface, CustomDecodingSignal, CustomProperty, CustomStruct, DataDestinationConfig, DataPartition, DataPartitionStorageOptions, DataPartitionUploadOptions, DecoderManifestSummary, DecoderManifestValidationException, DeleteCampaignRequest, DeleteCampaignResponse, DeleteDecoderManifestRequest, DeleteDecoderManifestResponse, DeleteFleetRequest, DeleteFleetResponse, DeleteModelManifestRequest, DeleteModelManifestResponse, DeleteSignalCatalogRequest, DeleteSignalCatalogResponse, DeleteStateTemplateRequest, DeleteStateTemplateResponse, DeleteVehicleRequest, DeleteVehicleResponse, DisassociateVehicleFleetRequest, DisassociateVehicleFleetResponse, FleetSummary, FormattedVss, GetCampaignRequest, GetCampaignResponse, GetDecoderManifestRequest, GetDecoderManifestResponse, GetEncryptionConfigurationResponse, GetFleetRequest, GetFleetResponse, GetLoggingOptionsResponse, GetModelManifestRequest, GetModelManifestResponse, GetRegisterAccountStatusResponse, GetSignalCatalogRequest, GetSignalCatalogResponse, GetStateTemplateRequest, GetStateTemplateResponse, GetVehicleRequest, GetVehicleResponse, GetVehicleStatusRequest, GetVehicleStatusResponse, IamRegistrationResponse, IamResources, ImportDecoderManifestRequest, ImportDecoderManifestResponse, ImportSignalCatalogRequest, ImportSignalCatalogResponse, InternalServerException, InvalidNetworkInterface, InvalidNodeException, InvalidSignal, InvalidSignalDecoder, InvalidSignalsException, LimitExceededException, ListCampaignsRequest, ListCampaignsResponse, ListDecoderManifestNetworkInterfacesRequest, ListDecoderManifestNetworkInterfacesResponse, ListDecoderManifestSignalsRequest, ListDecoderManifestSignalsResponse, ListDecoderManifestsRequest, ListDecoderManifestsResponse, ListFleetsForVehicleRequest, ListFleetsForVehicleResponse, ListFleetsRequest, ListFleetsResponse, ListModelManifestNodesRequest, ListModelManifestNodesResponse, ListModelManifestsRequest, ListModelManifestsResponse, ListSignalCatalogNodesRequest, ListSignalCatalogNodesResponse, ListSignalCatalogsRequest, ListSignalCatalogsResponse, ListStateTemplatesRequest, ListStateTemplatesResponse, ListTagsForResourceRequest, ListTagsForResourceResponse, ListVehiclesInFleetRequest, ListVehiclesInFleetResponse, ListVehiclesRequest, ListVehiclesResponse, MessageSignal, ModelManifestSummary, MqttTopicConfig, NetworkFileDefinition, NetworkInterface, Node, NodeCounts, ObdInterface, ObdSignal, PeriodicStateTemplateUpdateStrategy, PrimitiveMessageDefinition, PutEncryptionConfigurationRequest, PutEncryptionConfigurationResponse, PutLoggingOptionsRequest, PutLoggingOptionsResponse, ROS2PrimitiveMessageDefinition, RegisterAccountRequest, RegisterAccountResponse, ResourceNotFoundException, S3Config, Sensor, SignalCatalogSummary, SignalDecoder, SignalFetchConfig, SignalFetchInformation, SignalInformation, StateTemplateAssociation, StateTemplateSummary, StateTemplateUpdateStrategy, StorageMaximumSize, StorageMinimumTimeToLive, StructuredMessage, StructuredMessageFieldNameAndDataTypePair, StructuredMessageListDefinition, Tag, TagResourceRequest, TagResourceResponse, ThrottlingException, TimeBasedCollectionScheme, TimeBasedSignalFetchConfig, TimePeriod, TimestreamConfig, TimestreamRegistrationResponse, TimestreamResources, UntagResourceRequest, UntagResourceResponse, UpdateCampaignRequest, UpdateCampaignResponse, UpdateDecoderManifestRequest, UpdateDecoderManifestResponse, UpdateFleetRequest, UpdateFleetResponse, UpdateModelManifestRequest, UpdateModelManifestResponse, UpdateSignalCatalogRequest, UpdateSignalCatalogResponse, UpdateStateTemplateRequest, UpdateStateTemplateResponse, UpdateVehicleError, UpdateVehicleRequest, UpdateVehicleRequestItem, UpdateVehicleResponse, UpdateVehicleResponseItem, ValidationException, ValidationExceptionField, VehicleMiddleware, VehicleStatus, VehicleSummary

Instance Attribute Summary collapse

Instance Attribute Details

#actuator ⇒ Types::Actuator

Information about a node specified as an actuator.

An actuator is a digital representation of a vehicle device.

Returns:



3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3558

class Node < Struct.new(
  :branch,
  :sensor,
  :actuator,
  :attribute,
  :struct,
  :property,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Branch < Node; end
  class Sensor < Node; end
  class Actuator < Node; end
  class Attribute < Node; end
  class Struct < Node; end
  class Property < Node; end
  class Unknown < Node; end
end

#attribute ⇒ Types::Attribute

Information about a node specified as an attribute.

An attribute represents static information about a vehicle.

Returns:



3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3558

class Node < Struct.new(
  :branch,
  :sensor,
  :actuator,
  :attribute,
  :struct,
  :property,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Branch < Node; end
  class Sensor < Node; end
  class Actuator < Node; end
  class Attribute < Node; end
  class Struct < Node; end
  class Property < Node; end
  class Unknown < Node; end
end

#branch ⇒ Types::Branch

Information about a node specified as a branch.

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

Returns:



3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3558

class Node < Struct.new(
  :branch,
  :sensor,
  :actuator,
  :attribute,
  :struct,
  :property,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Branch < Node; end
  class Sensor < Node; end
  class Actuator < Node; end
  class Attribute < Node; end
  class Struct < Node; end
  class Property < Node; end
  class Unknown < Node; end
end

#can_dbc ⇒ Types::CanDbcDefinition

Information, including CAN DBC files, about the configurations used to create a decoder manifest.

Returns:



3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3445

class NetworkFileDefinition < Struct.new(
  :can_dbc,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class CanDbc < NetworkFileDefinition; end
  class Unknown < NetworkFileDefinition; end
end

#condition_based ⇒ Types::ConditionBasedSignalFetchConfig

The configuration of a condition-based signal fetch operation.

Returns:



4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 4178

class SignalFetchConfig < Struct.new(
  :time_based,
  :condition_based,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class TimeBased < SignalFetchConfig; end
  class ConditionBased < SignalFetchConfig; end
  class Unknown < SignalFetchConfig; end
end

#condition_based_collection_scheme ⇒ Types::ConditionBasedCollectionScheme

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

Returns:



478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 478

class CollectionScheme < Struct.new(
  :time_based_collection_scheme,
  :condition_based_collection_scheme,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class TimeBasedCollectionScheme < CollectionScheme; end
  class ConditionBasedCollectionScheme < CollectionScheme; end
  class Unknown < CollectionScheme; end
end

#mqtt_topic_config ⇒ Types::MqttTopicConfig

The MQTT topic to which the Amazon Web Services IoT FleetWise campaign routes data.

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.

Returns:



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 1335

class DataDestinationConfig < Struct.new(
  :s3_config,
  :timestream_config,
  :mqtt_topic_config,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class S3Config < DataDestinationConfig; end
  class TimestreamConfig < DataDestinationConfig; end
  class MqttTopicConfig < DataDestinationConfig; end
  class Unknown < DataDestinationConfig; end
end

#on_change ⇒ Types::OnChangeStateTemplateUpdateStrategy

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

Returns:

  • (Types::OnChangeStateTemplateUpdateStrategy) 


4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 4400

class StateTemplateUpdateStrategy < Struct.new(
  :periodic,
  :on_change,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Periodic < StateTemplateUpdateStrategy; end
  class OnChange < StateTemplateUpdateStrategy; end
  class Unknown < StateTemplateUpdateStrategy; end
end

#periodic ⇒ Types::PeriodicStateTemplateUpdateStrategy

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

Returns:



4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 4400

class StateTemplateUpdateStrategy < Struct.new(
  :periodic,
  :on_change,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Periodic < StateTemplateUpdateStrategy; end
  class OnChange < StateTemplateUpdateStrategy; end
  class Unknown < StateTemplateUpdateStrategy; end
end

#primitive_message_definition ⇒ Types::PrimitiveMessageDefinition

Represents a primitive type node of the complex data structure.

Returns:



4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 4486

class StructuredMessage < Struct.new(
  :primitive_message_definition,
  :structured_message_list_definition,
  :structured_message_definition,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class PrimitiveMessageDefinition < StructuredMessage; end
  class StructuredMessageListDefinition < StructuredMessage; end
  class StructuredMessageDefinition < StructuredMessage; end
  class Unknown < StructuredMessage; end
end

#property ⇒ Types::CustomProperty

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

Returns:



3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3558

class Node < Struct.new(
  :branch,
  :sensor,
  :actuator,
  :attribute,
  :struct,
  :property,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Branch < Node; end
  class Sensor < Node; end
  class Actuator < Node; end
  class Attribute < Node; end
  class Struct < Node; end
  class Property < Node; end
  class Unknown < Node; end
end

#ros2_primitive_message_definition ⇒ Types::ROS2PrimitiveMessageDefinition

Information about a PrimitiveMessage using a ROS 2 compliant primitive type message of the complex data structure.

Returns:



3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3770

class PrimitiveMessageDefinition < Struct.new(
  :ros2_primitive_message_definition,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Ros2PrimitiveMessageDefinition < PrimitiveMessageDefinition; end
  class Unknown < PrimitiveMessageDefinition; end
end

#s3_config ⇒ Types::S3Config

The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.

Returns:



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 1335

class DataDestinationConfig < Struct.new(
  :s3_config,
  :timestream_config,
  :mqtt_topic_config,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class S3Config < DataDestinationConfig; end
  class TimestreamConfig < DataDestinationConfig; end
  class MqttTopicConfig < DataDestinationConfig; end
  class Unknown < DataDestinationConfig; end
end

#sensor ⇒ Types::Sensor

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

You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.

Returns:



3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3558

class Node < Struct.new(
  :branch,
  :sensor,
  :actuator,
  :attribute,
  :struct,
  :property,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Branch < Node; end
  class Sensor < Node; end
  class Actuator < Node; end
  class Attribute < Node; end
  class Struct < Node; end
  class Property < Node; end
  class Unknown < Node; end
end

#struct ⇒ Types::CustomStruct

Represents a complex or higher-order data structure.

Returns:



3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3558

class Node < Struct.new(
  :branch,
  :sensor,
  :actuator,
  :attribute,
  :struct,
  :property,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Branch < Node; end
  class Sensor < Node; end
  class Actuator < Node; end
  class Attribute < Node; end
  class Struct < Node; end
  class Property < Node; end
  class Unknown < Node; end
end

#structured_message_definition ⇒ Array<Types::StructuredMessageFieldNameAndDataTypePair>

Represents a struct type node of the complex data structure.

Returns:



4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 4486

class StructuredMessage < Struct.new(
  :primitive_message_definition,
  :structured_message_list_definition,
  :structured_message_definition,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class PrimitiveMessageDefinition < StructuredMessage; end
  class StructuredMessageListDefinition < StructuredMessage; end
  class StructuredMessageDefinition < StructuredMessage; end
  class Unknown < StructuredMessage; end
end

#structured_message_list_definition ⇒ Types::StructuredMessageListDefinition

Represents a list type node of the complex data structure.

Returns:



4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 4486

class StructuredMessage < Struct.new(
  :primitive_message_definition,
  :structured_message_list_definition,
  :structured_message_definition,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class PrimitiveMessageDefinition < StructuredMessage; end
  class StructuredMessageListDefinition < StructuredMessage; end
  class StructuredMessageDefinition < StructuredMessage; end
  class Unknown < StructuredMessage; end
end

#time_based ⇒ Types::TimeBasedSignalFetchConfig

The configuration of a time-based signal fetch operation.

Returns:



4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 4178

class SignalFetchConfig < Struct.new(
  :time_based,
  :condition_based,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class TimeBased < SignalFetchConfig; end
  class ConditionBased < SignalFetchConfig; end
  class Unknown < SignalFetchConfig; end
end

#time_based_collection_scheme ⇒ Types::TimeBasedCollectionScheme

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

Returns:



478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 478

class CollectionScheme < Struct.new(
  :time_based_collection_scheme,
  :condition_based_collection_scheme,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class TimeBasedCollectionScheme < CollectionScheme; end
  class ConditionBasedCollectionScheme < CollectionScheme; end
  class Unknown < CollectionScheme; end
end

#timestream_config ⇒ Types::TimestreamConfig

The Amazon Timestream table where the campaign sends data.

Returns:



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 1335

class DataDestinationConfig < Struct.new(
  :s3_config,
  :timestream_config,
  :mqtt_topic_config,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class S3Config < DataDestinationConfig; end
  class TimestreamConfig < DataDestinationConfig; end
  class MqttTopicConfig < DataDestinationConfig; end
  class Unknown < DataDestinationConfig; end
end

#vss_json ⇒ String

Provides the VSS in JSON format.

Returns:

  • (String) 


1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
 
# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 1790

class FormattedVss < Struct.new(
  :vss_json,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class VssJson < FormattedVss; end
  class Unknown < FormattedVss; end
end