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, ConflictException, CreateCampaignRequest, CreateCampaignResponse, CreateDecoderManifestRequest, CreateDecoderManifestResponse, CreateFleetRequest, CreateFleetResponse, CreateModelManifestRequest, CreateModelManifestResponse, CreateSignalCatalogRequest, CreateSignalCatalogResponse, CreateVehicleError, CreateVehicleRequest, CreateVehicleRequestItem, CreateVehicleResponse, CreateVehicleResponseItem, CustomProperty, CustomStruct, DataDestinationConfig, DecoderManifestSummary, DecoderManifestValidationException, DeleteCampaignRequest, DeleteCampaignResponse, DeleteDecoderManifestRequest, DeleteDecoderManifestResponse, DeleteFleetRequest, DeleteFleetResponse, DeleteModelManifestRequest, DeleteModelManifestResponse, DeleteSignalCatalogRequest, DeleteSignalCatalogResponse, DeleteVehicleRequest, DeleteVehicleResponse, DisassociateVehicleFleetRequest, DisassociateVehicleFleetResponse, FleetSummary, FormattedVss, GetCampaignRequest, GetCampaignResponse, GetDecoderManifestRequest, GetDecoderManifestResponse, GetEncryptionConfigurationRequest, GetEncryptionConfigurationResponse, GetFleetRequest, GetFleetResponse, GetLoggingOptionsRequest, GetLoggingOptionsResponse, GetModelManifestRequest, GetModelManifestResponse, GetRegisterAccountStatusRequest, GetRegisterAccountStatusResponse, GetSignalCatalogRequest, GetSignalCatalogResponse, 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, ListTagsForResourceRequest, ListTagsForResourceResponse, ListVehiclesInFleetRequest, ListVehiclesInFleetResponse, ListVehiclesRequest, ListVehiclesResponse, MessageSignal, ModelManifestSummary, NetworkFileDefinition, NetworkInterface, Node, NodeCounts, ObdInterface, ObdSignal, PrimitiveMessageDefinition, PutEncryptionConfigurationRequest, PutEncryptionConfigurationResponse, PutLoggingOptionsRequest, PutLoggingOptionsResponse, ROS2PrimitiveMessageDefinition, RegisterAccountRequest, RegisterAccountResponse, ResourceNotFoundException, S3Config, Sensor, SignalCatalogSummary, SignalDecoder, SignalInformation, StructuredMessage, StructuredMessageFieldNameAndDataTypePair, StructuredMessageListDefinition, Tag, TagResourceRequest, TagResourceResponse, ThrottlingException, TimeBasedCollectionScheme, TimestreamConfig, TimestreamRegistrationResponse, TimestreamResources, UntagResourceRequest, UntagResourceResponse, UpdateCampaignRequest, UpdateCampaignResponse, UpdateDecoderManifestRequest, UpdateDecoderManifestResponse, UpdateFleetRequest, UpdateFleetResponse, UpdateModelManifestRequest, UpdateModelManifestResponse, UpdateSignalCatalogRequest, UpdateSignalCatalogResponse, 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:



2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 2983

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:



2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 2983

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:



2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 2983

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:



2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 2879

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_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

#primitive_message_definition ⇒ Types::PrimitiveMessageDefinition

Represents a primitive type node of the complex data structure.

Returns:



3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3580

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:



2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 2983

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:



3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3161

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:



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1122

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

  class S3Config < DataDestinationConfig; end
  class TimestreamConfig < 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:



2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 2983

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:



2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 2983

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:



3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3580

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:



3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3580

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_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:



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1122

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

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

#vss_json ⇒ String

Provides the VSS in JSON format.

Returns:

  • (String) 


1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 1442

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

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