Module: Aws::IoTFleetWise::Types

Defined in:
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, GetEncryptionConfigurationRequest, GetEncryptionConfigurationResponse, GetFleetRequest, GetFleetResponse, GetLoggingOptionsRequest, GetLoggingOptionsResponse, GetModelManifestRequest, GetModelManifestResponse, GetRegisterAccountStatusRequest, 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, OnChangeStateTemplateUpdateStrategy, 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.

<note markdown=“1”> An actuator is a digital representation of a vehicle device.

</note>

Returns:



3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3507

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.

<note markdown=“1”> An attribute represents static information about a vehicle.

</note>

Returns:



3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3507

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.

<note markdown=“1”> A group of signals that are defined in a hierarchical structure.

</note>

Returns:



3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3507

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:



3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3394

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:



4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4113

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:



469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 469

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*.

[1]: docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html

Returns:



1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1326

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:



4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4335

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:



4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4335

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:



4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4421

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:



3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3507

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:



3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3705

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:



1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1326

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.

<note markdown=“1”> You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.

</note>

Returns:



3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3507

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:



3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3507

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:



4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4421

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:



4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4421

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:



4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4113

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:



469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 469

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:



1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1326

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) 


1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1781

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

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