Smaws_Client_IoTFleetWise.Typestype nonrec vehicles = vehicle_name listtype nonrec attributes_map = (attribute_name * attribute_value) listtype nonrec vehicle_summary = {attributes : attributes_map option;Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
last_modification_time : timestamp;The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
*)creation_time : timestamp;The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
*)decoder_manifest_arn : arn;The ARN of a decoder manifest associated with the vehicle.
*)model_manifest_arn : arn;The ARN of a vehicle model (model manifest) associated with the vehicle.
*)arn : arn;The Amazon Resource Name (ARN) of the vehicle.
*)vehicle_name : vehicle_name;The unique ID of the vehicle.
*)}Information about a vehicle.
To return this information about vehicles in your account, you can use the API operation.
type nonrec vehicle_summaries = vehicle_summary listtype nonrec update_vehicle_response_item = {arn : arn option;The Amazon Resource Name (ARN) of the updated vehicle.
*)vehicle_name : vehicle_name option;The unique ID of the updated vehicle.
*)}Information about the updated vehicle.
type nonrec update_vehicle_response_items = update_vehicle_response_item listtype nonrec time_period = {value : positive_integer;A number of time units.
*)unit_ : time_unit;A unit of time.
*)}The length of time between state template updates.
Vehicles associated with the state template will stream telemetry data during a specified time period.
type nonrec state_template_update_strategy = | OnChange of on_change_state_template_update_strategy| Periodic of periodic_state_template_update_strategyThe update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an onChange or periodic update strategy.
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.
type nonrec state_template_association = {state_template_update_strategy : state_template_update_strategy;identifier : resource_identifier;The unique ID of the state template.
*)}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.
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.
type nonrec state_template_associations = state_template_association listtype nonrec state_template_association_identifiers = resource_identifier listtype nonrec update_vehicle_request_item = {state_templates_to_update : state_template_associations option;Change the stateTemplateUpdateStrategy of state templates already associated with the vehicle.
state_templates_to_remove : state_template_association_identifiers option;Remove existing state template associations from the vehicle.
*)state_templates_to_add : state_template_associations option;Associate additional state templates to track the state of the vehicle. State templates determine which signal updates the vehicle sends to the cloud.
*)attribute_update_mode : update_mode option;The method the specified attributes will update the existing attributes on the vehicle. UseOverwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.
This is required if attributes are present in the input.
*)attributes : attributes_map option;Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
decoder_manifest_arn : arn option;The ARN of the signal decoder manifest associated with the vehicle to update.
*)model_manifest_arn : arn option;The ARN of the vehicle model (model manifest) associated with the vehicle to update.
*)vehicle_name : vehicle_name;The unique ID of the vehicle to update.
*)}Information about the vehicle to update.
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.
type nonrec update_vehicle_request_items = update_vehicle_request_item listtype nonrec update_vehicle_error = {message : string_ option;A message associated with the error.
*)code : number option;The relevant HTTP error code (400+).
*)vehicle_name : vehicle_name option;The ID of the vehicle with the error.
*)}An HTTP error resulting from updating the description for a vehicle.
type nonrec update_vehicle_errors = update_vehicle_error listtype nonrec uint32 = Smaws_Lib.CoreTypes.Int64.ttype nonrec signal_catalog_summary = {last_modification_time : timestamp option;The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
*)creation_time : timestamp option;The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
*)arn : arn option;The Amazon Resource Name (ARN) of the signal catalog.
*)name : string_ option;The name of the signal catalog.
*)}Information about a collection of standardized signals, which can be attributes, branches, sensors, or actuators.
type nonrec signal_catalog_summaries = signal_catalog_summary listtype nonrec positive_long = Smaws_Lib.CoreTypes.Int64.ttype nonrec model_manifest_summary = {last_modification_time : timestamp;The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
*)creation_time : timestamp;The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
*)status : manifest_status option;The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. If the status is DRAFT, you can edit the vehicle model.
description : description option;A brief description of the vehicle model.
*)signal_catalog_arn : arn option;The ARN of the signal catalog associated with the vehicle model.
*)arn : arn option;The Amazon Resource Name (ARN) of the vehicle model.
*)name : string_ option;The name of the vehicle model.
*)}Information about a vehicle model (model manifest). You can use the API operation to return this information about multiple vehicle models.
type nonrec model_manifest_summaries = model_manifest_summary listtype nonrec max_string_size = Smaws_Lib.CoreTypes.Int64.ttype nonrec max_sample_count = Smaws_Lib.CoreTypes.Int64.ttype nonrec list_of_strings = string_ listtype nonrec fleets = fleet_id listtype nonrec fleet_summary = {last_modification_time : timestamp option;The time the fleet was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
*)creation_time : timestamp;The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
*)signal_catalog_arn : arn;The ARN of the signal catalog associated with the fleet.
*)description : description option;A brief description of the fleet.
*)arn : arn;The Amazon Resource Name (ARN) of the fleet.
*)id : fleet_id;The unique ID of the fleet.
*)}Information about a fleet.
You can use the API operation to return this information about multiple fleets.
type nonrec fleet_summaries = fleet_summary listtype nonrec decoder_manifest_summary = {message : message option;The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information.
last_modification_time : timestamp;The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
*)creation_time : timestamp;The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
*)status : manifest_status option;The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is marked DRAFT, you can edit the decoder manifest.
description : description option;A brief description of the decoder manifest.
*)model_manifest_arn : arn option;The ARN of a vehicle model (model manifest) associated with the decoder manifest.
*)arn : arn option;The ARN of a vehicle model (model manifest) associated with the decoder manifest.
*)name : string_ option;The name of the decoder manifest.
*)}Information about a created decoder manifest. You can use the API operation to return this information about multiple decoder manifests.
type nonrec decoder_manifest_summaries = decoder_manifest_summary listtype nonrec create_vehicle_response_item = {thing_arn : arn option;The ARN of a created or validated Amazon Web Services IoT thing.
*)arn : arn option;The ARN of the created vehicle.
*)vehicle_name : vehicle_name option;The unique ID of the vehicle to create.
*)}Information about a created vehicle.
type nonrec create_vehicle_responses = create_vehicle_response_item listA set of key/value pairs that are used to manage the resource.
type nonrec tag_list = tag listtype nonrec create_vehicle_request_item = {state_templates : state_template_associations option;Associate state templates to track the state of the vehicle. State templates determine which signal updates the vehicle sends to the cloud.
*)association_behavior : vehicle_association_behavior option;An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
*)attributes : attributes_map option;Static information about a vehicle in a key-value pair. For example: "engine Type" : "v6"
decoder_manifest_arn : arn;The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
*)model_manifest_arn : arn;The ARN of the vehicle model (model manifest) to create the vehicle from.
*)vehicle_name : vehicle_name;The unique ID of the vehicle to create.
*)}Information about the vehicle to create.
type nonrec create_vehicle_request_items = create_vehicle_request_item listtype nonrec create_vehicle_error = {message : string_ option;A description of the HTTP error.
*)code : string_ option;An HTTP error code.
*)vehicle_name : vehicle_name option;The ID of the vehicle with the error.
*)}An HTTP error resulting from creating a vehicle.
type nonrec create_vehicle_errors = create_vehicle_error listtype nonrec collection_period_ms = Smaws_Lib.CoreTypes.Int64.ttype nonrec campaign_summary = {last_modification_time : timestamp;The last time the campaign was modified.
*)creation_time : timestamp;The time the campaign was created.
*)status : campaign_status option;The state of a campaign. The status can be one of the following:
CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.RUNNING - The campaign is active.SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.target_arn : arn option;The ARN of a vehicle or fleet to which the campaign is deployed.
*)signal_catalog_arn : arn option;The ARN of the signal catalog associated with the campaign.
*)description : description option;The description of the campaign.
*)name : campaign_name option;The name of a campaign.
*)arn : campaign_arn option;The Amazon Resource Name (ARN) of a campaign.
*)}Information about a campaign.
You can use the API operation to return this information about multiple created campaigns.
type nonrec campaign_summaries = campaign_summary listtype nonrec attribute_values_list = attribute_value listtype nonrec attribute_names_list = attribute_name listtype nonrec vehicle_status = {status : vehicle_state option;The status of a campaign, which can be one of the following:
CREATED - The campaign exists but is not yet approved.READY - The campaign is approved but has not been deployed to the vehicle. Data has not arrived at the vehicle yet.HEALTHY - The campaign is deployed to the vehicle.SUSPENDED - The campaign is suspended and data collection is paused.DELETING - The campaign is being removed from the vehicle.READY_FOR_CHECKIN - The campaign is approved and waiting for vehicle check-in before deployment.vehicle_name : vehicle_name option;The unique ID of the vehicle.
*)campaign_name : campaign_name option;The name of a campaign.
*)}Information about a campaign associated with a vehicle.
type nonrec vehicle_status_list = vehicle_status listtype nonrec vehicle_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec vehicle_middleware = {protocol_name : vehicle_middleware_protocol;The protocol name of the vehicle middleware.
*)name : vehicle_middleware_name;The name of the vehicle middleware.
*)}The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.
type nonrec vehicle_association_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec validation_exception_field = {message : Smaws_Lib.Smithy_api.Types.string_;A message about the validation error.
*)name : Smaws_Lib.Smithy_api.Types.string_;The name of the parameter field with the validation error.
*)}A validation error due to mismatch between the expected data type, length, or pattern of the parameter and the input.
type nonrec validation_exception_field_list = validation_exception_field listtype nonrec validation_exception = {field_list : validation_exception_field_list option;The list of fields that fail to satisfy the constraints specified by an Amazon Web Services service.
*)reason : validation_exception_reason option;The reason the input failed to satisfy the constraints specified by an Amazon Web Services service.
*)message : string_;}The input fails to satisfy the constraints specified by an Amazon Web Services service.
type nonrec update_vehicle_response = {arn : arn option;The ARN of the updated vehicle.
*)vehicle_name : vehicle_name option;The ID of the updated vehicle.
*)}type nonrec update_vehicle_request = {state_templates_to_update : state_template_associations option;Change the stateTemplateUpdateStrategy of state templates already associated with the vehicle.
state_templates_to_remove : state_template_association_identifiers option;Remove state templates from the vehicle.
*)state_templates_to_add : state_template_associations option;Associate state templates with the vehicle.
*)attribute_update_mode : update_mode option;The method the specified attributes will update the existing attributes on the vehicle. UseOverwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.
This is required if attributes are present in the input.
*)attributes : attributes_map option;Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
decoder_manifest_arn : arn option;The ARN of the decoder manifest associated with this vehicle.
*)model_manifest_arn : arn option;The ARN of a vehicle model (model manifest) associated with the vehicle.
*)vehicle_name : vehicle_name;The unique ID of the vehicle to update.
*)}type nonrec throttling_exception = {retry_after_seconds : retry_after_seconds option;The number of seconds to wait before retrying the command.
*)service_code : string_ option;The code for the service that couldn't be completed due to throttling.
*)quota_code : string_ option;The quota identifier of the applied throttling rules for this request.
*)message : string_;}The request couldn't be completed due to throttling.
type nonrec resource_not_found_exception = {resource_type : string_;The type of resource that wasn't found.
*)resource_id : string_;The identifier of the resource that wasn't found.
*)message : string_;}The resource wasn't found.
type nonrec limit_exceeded_exception = {resource_type : string_;The type of resource that was exceeded.
*)resource_id : string_;The identifier of the resource that was exceeded.
*)message : string_;}A service quota was exceeded.
type nonrec internal_server_exception = {retry_after_seconds : retry_after_seconds option;The number of seconds to wait before retrying the command.
*)message : string_;}The request couldn't be completed because the server temporarily failed.
type nonrec conflict_exception = {resource_type : string_;The type of resource on which there are conflicting operations..
*)resource : string_;The resource on which there are conflicting operations.
*)message : string_;}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.
You don't have sufficient permission to perform this action.
type nonrec update_state_template_response = {id : resource_unique_id option;The unique ID of the state template.
*)arn : arn option;The Amazon Resource Name (ARN) of the state template.
*)name : resource_name option;The name of the state template.
*)}type nonrec state_template_properties = node_path listtype nonrec state_template_data_extra_dimension_node_path_list = node_path listtype nonrec state_template_metadata_extra_dimension_node_path_list =
node_path listtype nonrec update_state_template_request = {metadata_extra_dimensions : state_template_metadata_extra_dimension_node_path_list
option;A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.
data_extra_dimensions : state_template_data_extra_dimension_node_path_list
option;A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions field.
Default: An empty array
*)state_template_properties_to_remove : state_template_properties option;Remove signals from which data is collected as part of the state template.
*)state_template_properties_to_add : state_template_properties option;Add signals from which data is collected as part of the state template.
*)description : description option;A brief description of the state template.
*)identifier : resource_identifier;The unique ID of the state template.
*)}type nonrec invalid_signal = {reason : string_ option;A message about why the signal isn't valid.
*)name : fully_qualified_name option;The name of the signal that isn't valid.
*)}A reason that a signal isn't valid.
type nonrec invalid_signals = invalid_signal listtype nonrec invalid_signals_exception = {invalid_signals : invalid_signals option;The signals which caused the exception.
*)message : string_ option;}The request couldn't be completed because it contains signals that aren't valid.
type nonrec update_signal_catalog_response = {arn : arn;The ARN of the updated signal catalog.
*)name : resource_name;The name of the updated signal catalog.
*)}type nonrec branch = {comment : message option;A comment in addition to the description.
*)deprecation_message : message option;The deprecation message for the node or the branch that was moved or deleted.
*)description : description option;A brief description of the branch.
*)fully_qualified_name : string_;The fully qualified name of the branch. For example, the fully qualified name of a branch might be Vehicle.Body.Engine.
}A group of signals that are defined in a hierarchical structure.
type nonrec node_data_type = | STRUCT_ARRAY| STRUCT| UNKNOWN| UNIX_TIMESTAMP_ARRAY| STRING_ARRAY| DOUBLE_ARRAY| FLOAT_ARRAY| BOOLEAN_ARRAY| UINT64_ARRAY| INT64_ARRAY| UINT32_ARRAY| INT32_ARRAY| UINT16_ARRAY| INT16_ARRAY| UINT8_ARRAY| INT8_ARRAY| UNIX_TIMESTAMP| STRING| DOUBLE| FLOAT| BOOLEAN| UINT64| INT64| UINT32| INT32| UINT16| INT16| UINT8| INT8type nonrec sensor = {struct_fully_qualified_name : node_path option;The fully qualified name of the struct node for a sensor if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of a sensor might be Vehicle.ADAS.CameraStruct.
comment : message option;A comment in addition to the description.
*)deprecation_message : message option;The deprecation message for the node or the branch that was moved or deleted.
*)max : double option;The specified possible maximum value of the sensor.
*)min : double option;The specified possible minimum value of the sensor.
*)allowed_values : list_of_strings option;A list of possible values a sensor can take.
*)unit_ : string_ option;The scientific unit of measurement for data collected by the sensor.
*)description : description option;A brief description of a sensor.
*)data_type : node_data_type;The specified data type of the sensor.
*)fully_qualified_name : string_;The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery.
}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.
type nonrec actuator = {struct_fully_qualified_name : node_path option;The fully qualified name of the struct node for the actuator if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of an actuator might be Vehicle.Door.LockStruct.
comment : message option;A comment in addition to the description.
*)deprecation_message : message option;The deprecation message for the node or the branch that was moved or deleted.
*)assigned_value : string_ option;A specified value for the actuator.
*)max : double option;The specified possible maximum value of an actuator.
*)min : double option;The specified possible minimum value of an actuator.
*)allowed_values : list_of_strings option;A list of possible values an actuator can take.
*)unit_ : string_ option;The scientific unit for the actuator.
*)description : description option;A brief description of the actuator.
*)data_type : node_data_type;The specified data type of the actuator.
*)fully_qualified_name : string_;The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.
}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.
Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.
type nonrec attribute = {comment : message option;A comment in addition to the description.
*)deprecation_message : message option;The deprecation message for the node or the branch that was moved or deleted.
*)default_value : string_ option;The default value of the attribute.
*)assigned_value : string_ option;A specified value for the attribute.
*)max : double option;The specified possible maximum value of the attribute.
*)min : double option;The specified possible minimum value of the attribute.
*)allowed_values : list_of_strings option;A list of possible values an attribute can be assigned.
*)unit_ : string_ option;The scientific unit for the attribute.
*)description : description option;A brief description of the attribute.
*)data_type : node_data_type;The specified data type of the attribute.
*)fully_qualified_name : string_;The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type.
}A signal that represents static information about the vehicle, such as engine type or manufacturing date.
type nonrec custom_struct = {comment : message option;A comment in addition to the description.
*)deprecation_message : message option;The deprecation message for the node or the branch that was moved or deleted.
*)description : description option;A brief description of the custom structure.
*)fully_qualified_name : string_;The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be ComplexDataTypes.VehicleDataTypes.SVMCamera.
}The custom structure represents a complex or higher-order data structure.
type nonrec custom_property = {struct_fully_qualified_name : node_path option;The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray.
comment : message option;A comment in addition to the description.
*)deprecation_message : message option;The deprecation message for the node or the branch that was moved or deleted.
*)description : description option;A brief description of the custom property.
*)data_encoding : node_data_encoding option;Indicates whether the property is binary data.
*)data_type : node_data_type;The data type for the custom property.
*)fully_qualified_name : string_;The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS.
}Represents a member of the complex data structure. The data type of the property can be either primitive or another struct.
type nonrec node = | Property of custom_propertyRepresents a member of the complex data structure. The datatype of the property can be either primitive or another struct.
| Struct of custom_structRepresents a complex or higher-order data structure.
*)| Attribute of attributeInformation about a node specified as an attribute.
An attribute represents static information about a vehicle.
*)| Actuator of actuatorInformation about a node specified as an actuator.
An actuator is a digital representation of a vehicle device.
*)| Sensor of sensor| Branch of branchInformation about a node specified as a branch.
A group of signals that are defined in a hierarchical structure.
*)A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.
type nonrec nodes = node listtype nonrec node_paths = node_path listtype nonrec update_signal_catalog_request = {nodes_to_remove : node_paths option;A list of fullyQualifiedName of nodes to remove from the signal catalog.
nodes_to_update : nodes option;A list of information about nodes to update in the signal catalog.
*)nodes_to_add : nodes option;A list of information about nodes to add to the signal catalog.
*)description : description option;A brief description of the signal catalog to update.
*)name : resource_name;The name of the signal catalog to update.
*)}type nonrec invalid_node_exception = {message : string_ option;reason : string_ option;The reason the node validation failed.
*)invalid_nodes : nodes option;The specified node type isn't valid.
*)}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.
type nonrec update_model_manifest_response = {arn : arn;The Amazon Resource Name (ARN) of the updated vehicle model.
*)name : resource_name;The name of the updated vehicle model.
*)}type nonrec update_model_manifest_request = {status : manifest_status option;The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. If the status is DRAFT, you can edit the vehicle model.
nodes_to_remove : node_paths option;A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to remove from the vehicle model.
nodes_to_add : node_paths option;A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to add to the vehicle model.
description : description option;A brief description of the vehicle model.
*)name : resource_name;The name of the vehicle model to update.
*)}type nonrec update_fleet_request = {description : description option;An updated description of the fleet.
*)fleet_id : fleet_id;The ID of the fleet to update.
*)}type nonrec update_decoder_manifest_response = {arn : arn;The Amazon Resource Name (ARN) of the updated decoder manifest.
*)name : resource_name;The name of the updated decoder manifest.
*)}type nonrec can_signal = {signal_value_type : signal_value_type option;The value type of the signal. The default value is INTEGER.
name : can_signal_name option;The name of the signal.
*)length : non_negative_integer;How many bytes of data are in the message.
*)factor : double;A multiplier used to decode the CAN message.
*)offset : double;The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset.
start_bit : non_negative_integer;Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
is_signed : Smaws_Lib.Smithy_api.Types.primitive_boolean;Determines whether the message is signed (true) or not (false). If it's signed, the message can represent both positive and negative numbers. The isSigned parameter only applies to the INTEGER raw signal type, and it doesn't affect the FLOATING_POINT raw signal type.
is_big_endian : Smaws_Lib.Smithy_api.Types.primitive_boolean;Whether the byte ordering of a CAN message is big-endian.
*)message_id : non_negative_integer;The ID of the message.
*)}Information about a single controller area network (CAN) signal and the messages it receives and transmits.
type nonrec obd_signal = {signal_value_type : signal_value_type option;The value type of the signal. The default value is INTEGER.
is_signed : Smaws_Lib.Smithy_api.Types.primitive_boolean option;Determines whether the message is signed (true) or not (false). If it's signed, the message can represent both positive and negative numbers. The isSigned parameter only applies to the INTEGER raw signal type, and it doesn't affect the FLOATING_POINT raw signal type. The default value is false.
bit_mask_length : obd_bitmask_length option;The number of bits to mask in a message.
*)bit_right_shift : non_negative_integer option;The number of positions to shift bits in the message.
*)byte_length : obd_byte_length;The length of a message.
*)start_byte : non_negative_integer;Indicates the beginning of the message.
*)offset : double;The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.
scaling : double;A multiplier used to decode the message.
*)pid : non_negative_integer;The diagnostic code used to request data from a vehicle for this signal.
*)service_mode : non_negative_integer;The mode of operation (diagnostic service) in a message.
*)pid_response_length : positive_integer;The length of the requested data.
*)}Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
type nonrec ros2_primitive_message_definition = {upper_bound : max_string_size option;An optional attribute specifying the upper bound for STRING and WSTRING.
scaling : double option;A multiplier used to decode the message.
*)offset : double option;The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.
primitive_type : ros2_primitive_type;The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.
*)}Represents a ROS 2 compliant primitive type message of the complex data structure.
type nonrec primitive_message_definition = | Ros2PrimitiveMessageDefinition of ros2_primitive_message_definitionInformation about a PrimitiveMessage using a ROS 2 compliant primitive type message of the complex data structure.
Represents a primitive type node of the complex data structure.
type structured_message = | StructuredMessageDefinition of structured_message_definitionRepresents a struct type node of the complex data structure.
*)| StructuredMessageListDefinition of structured_message_list_definitionRepresents a list type node of the complex data structure.
*)| PrimitiveMessageDefinition of primitive_message_definitionRepresents a primitive type node of the complex data structure.
*)The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.
and structured_message_definition =
structured_message_field_name_and_data_type_pair listand structured_message_field_name_and_data_type_pair = {data_type : structured_message;The data type.
*)field_name : structure_message_name;The field name of the structured message. It determines how a data value is referenced in the target language.
*)}Represents a StructureMessageName to DataType map element.
and structured_message_list_definition = {capacity : non_negative_integer option;The capacity of the structured message list definition when the list type is FIXED_CAPACITY or DYNAMIC_BOUNDED_CAPACITY.
list_type : structured_message_list_type;The type of list of the structured message list definition.
*)member_type : structured_message;The member type of the structured message list definition.
*)name : structure_message_name;The name of the structured message list definition.
*)}Represents a list type node of the complex data structure.
type nonrec message_signal = {structured_message : structured_message;The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.
topic_name : topic_name;The topic name for the message signal. It corresponds to topics in ROS 2.
*)}The decoding information for a specific message which support higher order data types.
Information about signals using a custom decoding protocol as defined by the customer.
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.
type nonrec signal_decoder = {custom_decoding_signal : custom_decoding_signal option;Information about a custom signal decoder.
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.
*)message_signal : message_signal option;The decoding information for a specific message which supports higher order data types.
*)obd_signal : obd_signal option;Information about signal decoder using the on-board diagnostic (OBD) II protocol.
*)can_signal : can_signal option;Information about signal decoder using the Controller Area Network (CAN) protocol.
*)interface_id : interface_id;The ID of a network interface that specifies what network protocol a vehicle follows.
*)type_ : signal_decoder_type;The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
fully_qualified_name : fully_qualified_name;The fully qualified name of a signal decoder as defined in a vehicle model.
*)}Information about a signal decoder.
type nonrec signal_decoders = signal_decoder listtype nonrec fqns = fully_qualified_name listtype nonrec can_interface = {protocol_version : protocol_version option;The version of the communication protocol for the interface.
*)protocol_name : protocol_name option;The name of the communication protocol for the interface.
*)name : can_interface_name;The unique name of the interface.
*)}A single controller area network (CAN) device interface.
type nonrec obd_interface = {has_transmission_ecu : Smaws_Lib.Smithy_api.Types.primitive_boolean option;Whether the vehicle has a transmission control module (TCM).
*)use_extended_ids : Smaws_Lib.Smithy_api.Types.primitive_boolean option;Whether to use extended IDs in the message.
*)dtc_request_interval_seconds : non_negative_integer option;The maximum number message requests per diagnostic trouble code per second.
*)pid_request_interval_seconds : non_negative_integer option;The maximum number message requests per second.
*)obd_standard : obd_standard option;The standard OBD II PID.
*)request_message_id : non_negative_integer;The ID of the message requesting vehicle data.
*)name : obd_interface_name;The name of the interface.
*)}A network interface that specifies the on-board diagnostic (OBD) II network protocol.
type nonrec custom_decoding_interface = {name : custom_decoding_signal_interface_name;The name of the interface.
*)}Represents a custom network interface as defined by the customer.
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.
type nonrec network_interface = {custom_decoding_interface : custom_decoding_interface option;vehicle_middleware : vehicle_middleware option;The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.
obd_interface : obd_interface option;Information about a network interface specified by the on-board diagnostic (OBD) II protocol.
*)can_interface : can_interface option;Information about a network interface specified by the Controller Area Network (CAN) protocol.
*)type_ : network_interface_type;The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
interface_id : interface_id;The ID of the network interface.
*)}Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node.
To return this information about all the network interfaces specified in a decoder manifest, use the API operation.
type nonrec network_interfaces = network_interface listtype nonrec interface_ids = interface_id listtype nonrec update_decoder_manifest_request = {default_for_unmapped_signals : default_for_unmapped_signals_type option;Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.
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.
*)status : manifest_status option;The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.
network_interfaces_to_remove : interface_ids option;A list of network interfaces to remove from the decoder manifest.
*)network_interfaces_to_update : network_interfaces option;A list of information about the network interfaces to update in the decoder manifest.
*)network_interfaces_to_add : network_interfaces option;A list of information about the network interfaces to add to the decoder manifest.
*)signal_decoders_to_remove : fqns option;A list of signal decoders to remove from the decoder manifest.
*)signal_decoders_to_update : signal_decoders option;A list of updated information about decoding signals to update in the decoder manifest.
*)signal_decoders_to_add : signal_decoders option;A list of information about decoding additional signals to add to the decoder manifest.
*)description : description option;A brief description of the decoder manifest to update.
*)name : resource_name;The name of the decoder manifest to update.
*)}type nonrec signal_decoder_failure_reason = | CUSTOM_DECODING_SIGNAL_INFO_IS_NULL| EMPTY_MESSAGE_SIGNAL| SIGNAL_DECODER_INCOMPATIBLE_WITH_SIGNAL_CATALOG| NO_SIGNAL_IN_CATALOG_FOR_DECODER_SIGNAL| STRUCT_SIZE_MISMATCH| SIGNAL_DECODER_TYPE_INCOMPATIBLE_WITH_MESSAGE_SIGNAL_TYPE| MESSAGE_SIGNAL_INFO_IS_NULL| NO_DECODER_INFO_FOR_SIGNAL_IN_MODEL| OBD_SIGNAL_INFO_IS_NULL| CAN_SIGNAL_INFO_IS_NULL| SIGNAL_NOT_IN_MODEL| NETWORK_INTERFACE_TYPE_INCOMPATIBLE_WITH_SIGNAL_DECODER_TYPE| SIGNAL_NOT_ASSOCIATED_WITH_NETWORK_INTERFACE| SIGNAL_TO_ADD_ALREADY_EXISTS| CONFLICTING_SIGNAL| DUPLICATE_SIGNALtype nonrec invalid_signal_decoder = {hint : message option;The possible cause for the invalid signal decoder.
*)reason : signal_decoder_failure_reason option;A message about why the signal decoder isn't valid.
*)name : fully_qualified_name option;The name of a signal decoder that isn't valid.
*)}A reason that a signal decoder isn't valid.
type nonrec invalid_signal_decoders = invalid_signal_decoder listtype nonrec network_interface_failure_reason = | CUSTOM_DECODING_SIGNAL_NETWORK_INTERFACE_INFO_IS_NULL| VEHICLE_MIDDLEWARE_NETWORK_INTERFACE_INFO_IS_NULL| NETWORK_INTERFACE_TO_REMOVE_ASSOCIATED_WITH_SIGNALS| OBD_NETWORK_INTERFACE_INFO_IS_NULL| CAN_NETWORK_INTERFACE_INFO_IS_NULL| NETWORK_INTERFACE_TO_ADD_ALREADY_EXISTS| CONFLICTING_NETWORK_INTERFACE| DUPLICATE_INTERFACEtype nonrec invalid_network_interface = {reason : network_interface_failure_reason option;A message about why the interface isn't valid.
*)interface_id : interface_id option;The ID of the interface that isn't valid.
*)}A reason a vehicle network interface isn't valid.
type nonrec invalid_network_interfaces = invalid_network_interface listtype nonrec decoder_manifest_validation_exception = {message : string_ option;invalid_network_interfaces : invalid_network_interfaces option;The request couldn't be completed because of invalid network interfaces in the request.
*)invalid_signals : invalid_signal_decoders option;The request couldn't be completed because of invalid signals in the request.
*)}The request couldn't be completed because it contains signal decoders with one or more validation errors.
type nonrec update_campaign_response = {status : campaign_status option;The state of a campaign. The status can be one of:
CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.WAITING_FOR_APPROVAL - After you create a campaign, it enters this state. Use the API operation to approve the campaign for deployment to the target vehicle or fleet.RUNNING - The campaign is active.SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.name : campaign_name option;The name of the updated campaign.
*)arn : campaign_arn option;The Amazon Resource Name (ARN) of the campaign.
*)}type nonrec data_extra_dimension_node_path_list = node_path listtype nonrec update_campaign_request = {action : update_campaign_action;Specifies how to update a campaign. The action can be one of the following:
APPROVE - To approve delivering a data collection scheme to vehicles.SUSPEND - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.UPDATE - To update a campaign.data_extra_dimensions : data_extra_dimension_node_path_list option;A list of vehicle attributes to associate with a signal.
Default: An empty array
*)description : description option;The description of the campaign.
*)name : campaign_name;The name of the campaign to update.
*)}type nonrec tag_key_list = tag_key listtype nonrec untag_resource_request = {tag_keys : tag_key_list;A list of the keys of the tags to be removed from the resource.
*)resource_ar_n : amazon_resource_name;The ARN of the resource.
*)}type nonrec timestream_resources = {timestream_table_name : timestream_table_name;The name of the registered Amazon Timestream database table.
*)timestream_database_name : timestream_database_name;The name of the registered Amazon Timestream database.
*)}The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.
type nonrec timestream_registration_response = {error_message : error_message option;A message associated with a registration error.
*)registration_status : registration_status;The status of registering your Amazon Timestream resources. The status can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.
timestream_table_arn : arn option;The ARN of the Timestream database table.
*)timestream_database_arn : arn option;The Amazon Resource Name (ARN) of the Timestream database.
*)timestream_table_name : timestream_table_name;The name of the Timestream database table.
*)timestream_database_name : timestream_database_name;The name of the Timestream database.
*)}Information about the registered Amazon Timestream resources or errors, if any.
type nonrec timestream_config = {execution_role_arn : iam_role_arn;The Amazon Resource Name (ARN) of the task execution role that grants Amazon Web Services IoT FleetWise permission to deliver data to the Amazon Timestream table.
*)timestream_table_arn : timestream_table_arn;The Amazon Resource Name (ARN) of the Amazon Timestream table.
*)}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.
type nonrec time_based_signal_fetch_config = {execution_frequency_ms : positive_long;The frequency with which the signal fetch will be executed.
*)}Used to configure a frequency-based vehicle signal fetch.
type nonrec time_based_collection_scheme = {period_ms : collection_period_ms;The time period (in milliseconds) to decide how often to collect data. For example, if the time period is 60000, the Edge Agent software collects data once every minute.
}Information about a collection scheme that uses a time period to decide how often to collect data.
type nonrec tag_resource_request = {resource_ar_n : amazon_resource_name;The ARN of the resource.
*)}type nonrec storage_minimum_time_to_live = {value : storage_minimum_time_to_live_value;The minimum amount of time to store the data.
*)unit_ : storage_minimum_time_to_live_unit;The time increment type.
*)}Information about the minimum amount of time that data will be kept.
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.
type nonrec storage_maximum_size = {value : storage_maximum_size_value;The maximum amount of time to store data.
*)unit_ : storage_maximum_size_unit;The data type of the data to store.
*)}The maximum storage size for the data partition.
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.
type nonrec state_template_summary = {id : resource_unique_id option;The unique ID of the state template.
*)last_modification_time : timestamp option;The time the state template was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
*)creation_time : timestamp option;The time the state template was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
*)description : description option;A brief description of the state template.
*)signal_catalog_arn : arn option;The Amazon Resource Name (ARN) of the signal catalog associated with the state template.
*)arn : arn option;The Amazon Resource Name (ARN) of the state template.
*)name : resource_name option;The name of the state template.
*)}Information about a state template.
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.
type nonrec state_template_summaries = state_template_summary listtype nonrec state_template_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec signal_information = {data_partition_id : data_partition_id option;The ID of the data partition this signal is associated with.
The ID must match one of the IDs provided in dataPartitions. This is accomplished either by specifying a particular data partition ID or by using default for an established default partition. You can establish a default partition in the DataPartition data type.
If you upload a signal as a condition for a campaign's data partition, the same signal must be included in signalsToCollect.
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.
*)minimum_sampling_interval_ms : uint32 option;The minimum duration of time (in milliseconds) between two triggering events to collect data.
If a signal changes often, you might want to collect data at a slower rate.
*)max_sample_count : max_sample_count option;The maximum number of samples to collect.
*)name : wildcard_signal_name;The name of the signal.
*)}Information about a signal.
type nonrec signal_information_list = signal_information listtype nonrec condition_based_signal_fetch_config = {trigger_mode : trigger_mode;Indicates the mode in which the signal fetch is triggered.
*)condition_expression : fetch_config_event_expression;The condition that must be satisfied to trigger a signal fetch.
*)}Specifies the condition under which a signal fetch occurs.
type nonrec signal_fetch_config = | ConditionBased of condition_based_signal_fetch_configThe configuration of a condition-based signal fetch operation.
*)| TimeBased of time_based_signal_fetch_configThe configuration of a time-based signal fetch operation.
*)The configuration of the signal fetch operation.
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.
type nonrec event_expression_list = action_event_expression listtype nonrec signal_fetch_information = {actions : event_expression_list;The actions to be performed by the signal fetch.
*)condition_language_version : language_version option;The version of the condition language used.
*)signal_fetch_config : signal_fetch_config;The configuration of the signal fetch operation.
*)fully_qualified_name : node_path;The fully qualified name of the signal to be fetched.
*)}Information about the signal to be fetched.
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.
type nonrec signal_fetch_information_list = signal_fetch_information listtype nonrec signal_catalog_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec s3_config = {prefix : prefix option;Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
By default, Amazon Web Services IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles, the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.
storage_compression_format : storage_compression_format option;By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
*)data_format : data_format option;Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.
bucket_arn : s3_bucket_arn;The Amazon Resource Name (ARN) of the Amazon S3 bucket.
*)}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.
type nonrec iam_resources = {role_arn : iam_role_arn;The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream. For example, arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN.
}The IAM resource that enables Amazon Web Services IoT FleetWise edge agent software to send data to Amazon Timestream.
For more information, see IAM roles in the Identity and Access Management User Guide.
type nonrec register_account_response = {last_modification_time : timestamp;The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
*)creation_time : timestamp;The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).
*)iam_resources : iam_resources;The registered IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.
*)timestream_resources : timestream_resources option;register_account_status : registration_status;The status of registering your Amazon Web Services account, IAM role, and Timestream resources.
*)}type nonrec register_account_request = {iam_resources : iam_resources option;The IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.
*)timestream_resources : timestream_resources option;}type nonrec cloud_watch_log_delivery_options = {log_group_name : cloud_watch_log_group_name option;The Amazon CloudWatch Logs group the operation sends data to.
*)log_type : log_type;The type of log to send data to Amazon CloudWatch Logs.
*)}The log delivery option to send data to Amazon CloudWatch Logs.
type nonrec put_logging_options_request = {cloud_watch_log_delivery : cloud_watch_log_delivery_options;Creates or updates the log delivery option to Amazon CloudWatch Logs.
*)}type nonrec put_encryption_configuration_response = {encryption_type : encryption_type;The type of encryption. Set to KMS_BASED_ENCRYPTION to use an KMS key that you own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.
encryption_status : encryption_status;The encryption status.
*)kms_key_id : Smaws_Lib.Smithy_api.Types.string_ option;The ID of the KMS key that is used for encryption.
*)}type nonrec put_encryption_configuration_request = {encryption_type : encryption_type;The type of encryption. Choose KMS_BASED_ENCRYPTION to use a KMS key or FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key.
kms_key_id : Smaws_Lib.Smithy_api.Types.string_ option;The ID of the KMS key that is used for encryption.
*)}type nonrec node_counts = {total_properties : number option;The total properties for the node.
*)total_structs : number option;The total structure for the node.
*)total_actuators : number option;The total number of nodes in a vehicle network that represent actuators.
*)total_attributes : number option;The total number of nodes in a vehicle network that represent attributes.
*)total_sensors : number option;The total number of nodes in a vehicle network that represent sensors.
*)total_branches : number option;The total number of nodes in a vehicle network that represent branches.
*)total_nodes : number option;The total number of nodes in a vehicle network.
*)}Information about the number of nodes and node types in a vehicle network.
type nonrec network_files_list = network_file_blob listtype nonrec can_dbc_definition = {signals_map : model_signals_map option;Pairs every signal specified in your vehicle model with a signal decoder.
*)can_dbc_files : network_files_list;A list of DBC files. You can upload only one DBC file for each network interface and specify up to five (inclusive) files in the list. The DBC file can be a maximum size of 200 MB.
*)network_interface : interface_id;Contains information about a network interface.
*)}Configurations used to create a decoder manifest.
type nonrec network_file_definition = | CanDbc of can_dbc_definitionInformation, including CAN DBC files, about the configurations used to create a decoder manifest.
*)Specifications for defining a vehicle network.
type nonrec network_file_definitions = network_file_definition listtype nonrec mqtt_topic_config = {execution_role_arn : iam_role_arn;The ARN of the role that grants Amazon Web Services IoT FleetWise permission to access and act on messages sent to the MQTT topic.
*)mqtt_topic_arn : mqtt_topic_arn;The ARN of the MQTT topic.
*)}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.
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.
type nonrec model_manifest_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec list_vehicles_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
vehicle_summaries : vehicle_summaries option;A list of vehicles and information about them.
*)}type nonrec list_vehicles_request = {list_response_scope : list_response_scope option;When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: vehicle name, Amazon Resource Name (ARN), creation time, and last modification time.
max_results : list_vehicles_max_results option;The maximum number of items to return, between 1 and 100, inclusive.
*)next_token : next_token option;A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
attribute_values : attribute_values_list option;Static information about a vehicle attribute value in string format. You can use this optional parameter in conjunction with attributeNames to list the vehicles containing all the attributeValues corresponding to the attributeNames filter. For example, attributeValues could be "1.3 L R2, Blue" and the corresponding attributeNames filter could be "Vehicle.Body.Engine.Type, Vehicle.Color". In this case, the API will filter vehicles with attribute name Vehicle.Body.Engine.Type that contains a value of 1.3 L R2 AND an attribute name Vehicle.Color that contains a value of "Blue". A request must contain unique values for the attributeNames filter and the matching number of attributeValues filter to return the subset of vehicles that match the attributes filter condition.
attribute_names : attribute_names_list option;The fully qualified names of the attributes. You can use this optional parameter to list the vehicles containing all the attributes in the request. For example, attributeNames could be "Vehicle.Body.Engine.Type, Vehicle.Color" and the corresponding attributeValues could be "1.3 L R2, Blue" . In this case, the API will filter vehicles with an attribute name Vehicle.Body.Engine.Type that contains a value of 1.3 L R2 AND an attribute name Vehicle.Color that contains a value of "Blue". A request must contain unique values for the attributeNames filter and the matching number of attributeValues filters to return the subset of vehicles that match the attributes filter condition.
model_manifest_arn : arn option;The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional parameter to list only the vehicles created from a certain vehicle model.
*)}type nonrec list_vehicles_in_fleet_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
vehicles : vehicles option;A list of vehicles associated with the fleet.
*)}type nonrec list_vehicles_in_fleet_request = {max_results : max_results option;The maximum number of items to return, between 1 and 100, inclusive.
*)next_token : next_token option;A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
fleet_id : fleet_id;The ID of a fleet.
*)}type nonrec list_state_templates_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
summaries : state_template_summaries option;A list of information about each state template.
*)}type nonrec list_state_templates_request = {list_response_scope : list_response_scope option;When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: state template ID, Amazon Resource Name (ARN), creation time, and last modification time.
max_results : max_results option;The maximum number of items to return, between 1 and 100, inclusive.
*)next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
}type nonrec list_signal_catalogs_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
summaries : signal_catalog_summaries option;A list of information about each signal catalog.
*)}type nonrec list_signal_catalogs_request = {max_results : max_results option;The maximum number of items to return, between 1 and 100, inclusive.
*)next_token : next_token option;A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
}type nonrec list_signal_catalog_nodes_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
nodes : nodes option;A list of information about nodes.
*)}type nonrec list_signal_catalog_nodes_request = {signal_node_type : signal_node_type option;The type of node in the signal catalog.
*)max_results : max_results option;The maximum number of items to return, between 1 and 100, inclusive.
*)next_token : next_token option;A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
name : resource_name;The name of the signal catalog to list information about.
*)}type nonrec list_model_manifests_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
summaries : model_manifest_summaries option;A list of information about vehicle models.
*)}type nonrec list_model_manifests_request = {list_response_scope : list_response_scope option;When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: model manifest name, Amazon Resource Name (ARN), creation time, and last modification time.
max_results : max_results option;The maximum number of items to return, between 1 and 100, inclusive.
*)next_token : next_token option;A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
signal_catalog_arn : arn option;The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned.
*)}type nonrec list_model_manifest_nodes_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
nodes : nodes option;A list of information about nodes.
*)}type nonrec list_model_manifest_nodes_request = {max_results : max_results option;The maximum number of items to return, between 1 and 100, inclusive.
*)next_token : next_token option;A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
name : resource_name;The name of the vehicle model to list information about.
*)}type nonrec list_fleets_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
fleet_summaries : fleet_summaries option;A list of information for each fleet.
*)}type nonrec list_fleets_request = {list_response_scope : list_response_scope option;When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: fleet ID, Amazon Resource Name (ARN), creation time, and last modification time.
max_results : max_results option;The maximum number of items to return, between 1 and 100, inclusive.
*)next_token : next_token option;A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
}type nonrec list_fleets_for_vehicle_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
fleets : fleets option;A list of fleet IDs that the vehicle is associated with.
*)}type nonrec list_fleets_for_vehicle_request = {max_results : max_results option;The maximum number of items to return, between 1 and 100, inclusive.
*)next_token : next_token option;A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
vehicle_name : vehicle_name;The ID of the vehicle to retrieve information about.
*)}type nonrec list_decoder_manifests_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
summaries : decoder_manifest_summaries option;A list of information about each decoder manifest.
*)}type nonrec list_decoder_manifests_request = {list_response_scope : list_response_scope option;When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: decoder manifest name, Amazon Resource Name (ARN), creation time, and last modification time.
max_results : max_results option;The maximum number of items to return, between 1 and 100, inclusive.
*)next_token : next_token option;A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
model_manifest_arn : arn option;The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
*)}type nonrec list_decoder_manifest_signals_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
signal_decoders : signal_decoders option;Information about a list of signals to decode.
*)}type nonrec list_decoder_manifest_signals_request = {max_results : max_results option;The maximum number of items to return, between 1 and 100, inclusive.
*)next_token : next_token option;A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
name : resource_name;The name of the decoder manifest to list information about.
*)}type nonrec list_decoder_manifest_network_interfaces_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
network_interfaces : network_interfaces option;A list of information about network interfaces.
*)}type nonrec list_decoder_manifest_network_interfaces_request = {max_results : max_results option;The maximum number of items to return, between 1 and 100, inclusive.
*)next_token : next_token option;A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
name : resource_name;The name of the decoder manifest to list information about.
*)}type nonrec list_campaigns_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
campaign_summaries : campaign_summaries option;A summary of information about each campaign.
*)}type nonrec list_campaigns_request = {list_response_scope : list_response_scope option;When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: campaign name, Amazon Resource Name (ARN), creation time, and last modification time.
status : status_str option;An optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.
max_results : max_results option;The maximum number of items to return, between 1 and 100, inclusive.
*)next_token : next_token option;A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
}type nonrec get_vehicle_status_response = {next_token : next_token option;The token to retrieve the next set of results, or null if there are no more results.
campaigns : vehicle_status_list option;Lists information about the state of the vehicle with deployed campaigns.
*)}type nonrec get_vehicle_status_request = {vehicle_name : vehicle_name;The ID of the vehicle to retrieve information about.
*)max_results : max_results option;The maximum number of items to return, between 1 and 100, inclusive. This parameter is only supported for resources of type CAMPAIGN.
next_token : next_token option;A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. This parameter is only supported for resources of type CAMPAIGN.
}type nonrec iam_registration_response = {error_message : error_message option;A message associated with a registration error.
*)registration_status : registration_status;The status of registering your IAM resource. The status can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.
role_arn : arn;The Amazon Resource Name (ARN) of the IAM role to register.
*)}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.
type nonrec get_register_account_status_response = {last_modification_time : timestamp;The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
*)creation_time : timestamp;The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).
*)iam_registration_response : iam_registration_response;Information about the registered IAM resources or errors, if any.
*)timestream_registration_response : timestream_registration_response option;Information about the registered Amazon Timestream resources or errors, if any.
*)account_status : registration_status;The status of registering your account and resources. The status can be one of:
REGISTRATION_SUCCESS - The Amazon Web Services resource is successfully registered.REGISTRATION_PENDING - Amazon Web Services IoT FleetWise is processing the registration request. This process takes approximately five minutes to complete.REGISTRATION_FAILURE - Amazon Web Services IoT FleetWise can't register the AWS resource. Try again later.customer_account_id : customer_account_id;The unique ID of the Amazon Web Services account, provided at account creation.
*)}type nonrec get_logging_options_response = {cloud_watch_log_delivery : cloud_watch_log_delivery_options;Returns information about log delivery to Amazon CloudWatch Logs.
*)}type nonrec get_encryption_configuration_response = {last_modification_time : timestamp option;The time when encryption was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
*)creation_time : timestamp option;The time when encryption was configured in seconds since epoch (January 1, 1970 at midnight UTC time).
*)error_message : error_message option;The error message that describes why encryption settings couldn't be configured, if applicable.
*)encryption_type : encryption_type;The type of encryption. Set to KMS_BASED_ENCRYPTION to use a KMS key that you own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.
encryption_status : encryption_status;The encryption status.
*)kms_key_id : Smaws_Lib.Smithy_api.Types.string_ option;The ID of the KMS key that is used for encryption.
*)}type nonrec batch_update_vehicle_response = {errors : update_vehicle_errors option;A list of information about errors returned while updating a batch of vehicles, or, if there aren't any errors, an empty list.
*)vehicles : update_vehicle_response_items option;A list of information about the batch of updated vehicles.
This list contains only unique IDs for the vehicles that were updated.
*)}type nonrec batch_update_vehicle_request = {vehicles : update_vehicle_request_items;A list of information about the vehicles to update. For more information, see the API data type.
*)}type nonrec batch_create_vehicle_response = {errors : create_vehicle_errors option;A list of information about creation errors, or an empty list if there aren't any errors.
*)vehicles : create_vehicle_responses option;A list of information about a batch of created vehicles. For more information, see the API data type.
*)}type nonrec batch_create_vehicle_request = {vehicles : create_vehicle_request_items;A list of information about each vehicle to create. For more information, see the API data type.
*)}type nonrec import_signal_catalog_response = {arn : arn;The Amazon Resource Name (ARN) of the imported signal catalog.
*)name : resource_name;The name of the imported signal catalog.
*)}type nonrec formatted_vss = | VssJson of Smaws_Lib.Smithy_api.Types.string_Provides the VSS in JSON format.
*)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.
type nonrec import_signal_catalog_request = {vss : formatted_vss option;The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise language used to describe and model signals in vehicle networks.
*)description : description option;A brief description of the signal catalog.
*)name : resource_name;The name of the signal catalog to import.
*)}type nonrec import_decoder_manifest_response = {arn : arn;The Amazon Resource Name (ARN) of the decoder manifest that was imported.
*)name : resource_name;The name of the imported decoder manifest.
*)}type nonrec import_decoder_manifest_request = {network_file_definitions : network_file_definitions;The file to load into an Amazon Web Services account.
*)name : resource_name;The name of the decoder manifest to import.
*)}type nonrec get_vehicle_response = {last_modification_time : timestamp option;The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
*)creation_time : timestamp option;The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
*)state_templates : state_template_associations option;State templates associated with the vehicle.
*)attributes : attributes_map option;Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
decoder_manifest_arn : arn option;The ARN of a decoder manifest associated with the vehicle.
*)model_manifest_arn : arn option;The ARN of a vehicle model (model manifest) associated with the vehicle.
*)arn : arn option;The Amazon Resource Name (ARN) of the vehicle to retrieve information about.
*)vehicle_name : vehicle_name option;The ID of the vehicle.
*)}type nonrec get_vehicle_request = {vehicle_name : vehicle_name;The ID of the vehicle to retrieve information about.
*)}type nonrec get_state_template_response = {id : resource_unique_id option;The unique ID of the state template.
*)last_modification_time : timestamp option;The time the state template was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
*)creation_time : timestamp option;The time the state template was created in seconds since epoch (January 1, 1970 at midnight UTC time).
*)metadata_extra_dimensions : state_template_metadata_extra_dimension_node_path_list
option;A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic.
Default: An empty array
*)data_extra_dimensions : state_template_data_extra_dimension_node_path_list
option;A list of vehicle attributes associated with the payload published on the state template's MQTT topic.
Default: An empty array
*)state_template_properties : state_template_properties option;A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.
*)signal_catalog_arn : arn option;The ARN of the signal catalog associated with the state template.
*)description : description option;A brief description of the state template.
*)arn : arn option;The Amazon Resource Name (ARN) of the state template.
*)name : resource_name option;The name of the state template.
*)}type nonrec get_state_template_request = {identifier : resource_identifier;The unique ID of the state template.
*)}type nonrec get_signal_catalog_response = {last_modification_time : timestamp;The last time the signal catalog was modified.
*)creation_time : timestamp;The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
*)node_counts : node_counts option;The total number of network nodes specified in a signal catalog.
*)description : description option;A brief description of the signal catalog.
*)arn : arn;The Amazon Resource Name (ARN) of the signal catalog.
*)name : resource_name;The name of the signal catalog.
*)}type nonrec get_signal_catalog_request = {name : resource_name;The name of the signal catalog to retrieve information about.
*)}type nonrec get_model_manifest_response = {last_modification_time : timestamp;The last time the vehicle model was modified.
*)creation_time : timestamp;The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
*)status : manifest_status option;The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. You can edit the vehicle model if the status is marked DRAFT.
signal_catalog_arn : arn option;The ARN of the signal catalog associated with the vehicle model.
*)description : description option;A brief description of the vehicle model.
*)arn : arn;The Amazon Resource Name (ARN) of the vehicle model.
*)name : resource_name;The name of the vehicle model.
*)}type nonrec get_model_manifest_request = {name : resource_name;The name of the vehicle model to retrieve information about.
*)}type nonrec get_fleet_response = {last_modification_time : timestamp;The time the fleet was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
*)creation_time : timestamp;The time the fleet was created in seconds since epoch (January 1, 1970 at midnight UTC time).
*)signal_catalog_arn : arn;The ARN of a signal catalog associated with the fleet.
*)description : description option;A brief description of the fleet.
*)arn : arn;The Amazon Resource Name (ARN) of the fleet.
*)id : fleet_id;The ID of the fleet.
*)}type nonrec get_fleet_request = {fleet_id : fleet_id;The ID of the fleet to retrieve information about.
*)}type nonrec get_decoder_manifest_response = {message : message option;The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information.
last_modification_time : timestamp;The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
*)creation_time : timestamp;The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
*)status : manifest_status option;The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is marked DRAFT, you can edit the decoder manifest.
model_manifest_arn : arn option;The ARN of a vehicle model (model manifest) associated with the decoder manifest.
*)description : description option;A brief description of the decoder manifest.
*)arn : arn;The Amazon Resource Name (ARN) of the decoder manifest.
*)name : string_;The name of the decoder manifest.
*)}type nonrec get_decoder_manifest_request = {name : resource_name;The name of the decoder manifest to retrieve information about.
*)}type nonrec condition_based_collection_scheme = {condition_language_version : language_version option;Specifies the version of the conditional expression language.
*)trigger_mode : trigger_mode option;Whether to collect data for all triggering events (ALWAYS). Specify (RISING_EDGE), or specify only when the condition first evaluates to false. For example, triggering on "AirbagDeployed"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.
minimum_trigger_interval_ms : uint32 option;The minimum duration of time between two triggering events to collect data, in milliseconds.
If a signal changes often, you might want to collect data at a slower rate.
*)expression : event_expression;The logical expression used to recognize what data to collect. For example, $variable.`Vehicle.OutsideAirTemperature` >= 105.0.
}Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
type nonrec collection_scheme = | ConditionBasedCollectionScheme of condition_based_collection_schemeInformation about a collection scheme that uses a simple logical expression to recognize what data to collect.
*)| TimeBasedCollectionScheme of time_based_collection_schemeInformation about a collection scheme that uses a time period to decide how often to collect data.
*)Specifies what data to collect and how often or when to collect it.
type nonrec data_destination_config = | MqttTopicConfig of mqtt_topic_configThe 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.
*)| TimestreamConfig of timestream_configThe Amazon Timestream table where the campaign sends data.
*)| S3Config of s3_configThe Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.
*)The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.
type nonrec data_destination_configs = data_destination_config listtype nonrec data_partition_storage_options = {minimum_time_to_live : storage_minimum_time_to_live;The amount of time that data in this partition will be kept on disk.
storage_location : storage_location;The folder name for the data partition under the campaign storage folder.
*)maximum_size : storage_maximum_size;The maximum storage size of the data stored in the data partition.
Newer data overwrites older data when the partition reaches the maximum size.
*)}Size, time, and location options for the data partition.
type nonrec data_partition_upload_options = {condition_language_version : language_version option;The version of the condition language. Defaults to the most recent condition language version.
*)expression : event_expression;The logical expression used to recognize what data to collect. For example, $variable.`Vehicle.OutsideAirTemperature` >= 105.0.
}The upload options for the data partition. If upload options are specified, you must also specify storage options. See DataPartitionStorageOptions.
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.
type nonrec data_partition = {upload_options : data_partition_upload_options option;The upload options for the data partition.
*)storage_options : data_partition_storage_options;The storage options for a data partition.
*)id : data_partition_id;The ID of the data partition. The data partition ID must be unique within a campaign. You can establish a data partition as the default partition for a campaign by using default as the ID.
}The configuration for signal data storage and upload options. You can only specify these options when the campaign's spooling mode is TO_DISK.
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.
type nonrec data_partitions = data_partition listtype nonrec get_campaign_response = {signals_to_fetch : signal_fetch_information_list option;Information about a list of signals to fetch data from.
*)data_partitions : data_partitions option;The data partitions associated with the signals collected from the vehicle.
*)data_destination_configs : data_destination_configs option;The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.
MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
*)last_modification_time : timestamp option;The last time the campaign was modified.
*)creation_time : timestamp option;The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
*)data_extra_dimensions : data_extra_dimension_node_path_list option;A list of vehicle attributes associated with the campaign.
*)collection_scheme : collection_scheme option;Information about the data collection scheme associated with the campaign.
*)signals_to_collect : signal_information_list option;Information about a list of signals to collect data on.
*)priority : priority option;A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.
*)compression : compression option;Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.
spooling_mode : spooling_mode option;Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.
*)diagnostics_mode : diagnostics_mode option;Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
*)post_trigger_collection_duration : uint32 option;How long (in seconds) to collect raw data after a triggering event initiates the collection.
*)expiry_time : timestamp option;The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.
*)start_time : timestamp option;The time, in milliseconds, to deliver a campaign after it was approved.
*)status : campaign_status option;The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.
target_arn : arn option;The ARN of the vehicle or the fleet targeted by the campaign.
*)signal_catalog_arn : arn option;The ARN of a signal catalog.
*)description : description option;The description of the campaign.
*)arn : campaign_arn option;The Amazon Resource Name (ARN) of the campaign.
*)name : campaign_name option;The name of the campaign.
*)}type nonrec get_campaign_request = {name : campaign_name;The name of the campaign to retrieve information about.
*)}type nonrec fleet_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec fleet_association_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec disassociate_vehicle_fleet_request = {fleet_id : fleet_id;The unique ID of a fleet.
*)vehicle_name : vehicle_name;The unique ID of the vehicle to disassociate from the fleet.
*)}type nonrec delete_vehicle_response = {arn : arn;The Amazon Resource Name (ARN) of the deleted vehicle.
*)vehicle_name : vehicle_name;The ID of the deleted vehicle.
*)}type nonrec delete_vehicle_request = {vehicle_name : vehicle_name;The ID of the vehicle to delete.
*)}type nonrec delete_state_template_response = {id : resource_unique_id option;The unique ID of the state template.
*)arn : arn option;The Amazon Resource Name (ARN) of the state template.
*)name : resource_name option;The name of the state template.
*)}type nonrec delete_state_template_request = {identifier : resource_identifier;The unique ID of the state template.
*)}type nonrec delete_signal_catalog_response = {arn : arn;The Amazon Resource Name (ARN) of the deleted signal catalog.
*)name : resource_name;The name of the deleted signal catalog.
*)}type nonrec delete_signal_catalog_request = {name : resource_name;The name of the signal catalog to delete.
*)}type nonrec delete_model_manifest_response = {arn : arn;The Amazon Resource Name (ARN) of the deleted model manifest.
*)name : resource_name;The name of the deleted model manifest.
*)}type nonrec delete_model_manifest_request = {name : resource_name;The name of the model manifest to delete.
*)}type nonrec delete_decoder_manifest_response = {arn : arn;The Amazon Resource Name (ARN) of the deleted decoder manifest.
*)name : resource_name;The name of the deleted decoder manifest.
*)}type nonrec delete_decoder_manifest_request = {name : resource_name;The name of the decoder manifest to delete.
*)}type nonrec delete_campaign_response = {arn : campaign_arn option;The Amazon Resource Name (ARN) of the deleted campaign.
The ARN isn’t returned if a campaign doesn’t exist.
*)name : campaign_name option;The name of the deleted campaign.
*)}type nonrec delete_campaign_request = {name : campaign_name;The name of the campaign to delete.
*)}type nonrec decoder_manifest_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec create_vehicle_response = {thing_arn : arn option;The ARN of a created or validated Amazon Web Services IoT thing.
*)arn : arn option;The ARN of the created vehicle.
*)vehicle_name : vehicle_name option;The unique ID of the created vehicle.
*)}type nonrec create_vehicle_request = {state_templates : state_template_associations option;Associate state templates with the vehicle. You can monitor the last known state of the vehicle in near real time.
*)association_behavior : vehicle_association_behavior option;An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.
Default:
attributes : attributes_map option;Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"
To use attributes with Campaigns or State Templates, you must include them using the request parameters dataExtraDimensions and/or metadataExtraDimensions (for state templates only) when creating your campaign/state template.
decoder_manifest_arn : arn;The ARN of a decoder manifest.
*)model_manifest_arn : arn;The Amazon Resource Name ARN of a vehicle model.
*)vehicle_name : vehicle_name;The unique ID of the vehicle to create.
*)}type nonrec create_state_template_response = {id : resource_unique_id option;The unique ID of the state template.
*)arn : arn option;The Amazon Resource Name (ARN) of the state template.
*)name : resource_name option;The name of the state template.
*)}type nonrec create_state_template_request = {metadata_extra_dimensions : state_template_metadata_extra_dimension_node_path_list
option;A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.
Default: An empty array
*)data_extra_dimensions : state_template_data_extra_dimension_node_path_list
option;A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions field.
state_template_properties : state_template_properties;A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.
*)signal_catalog_arn : arn;The ARN of the signal catalog associated with the state template.
*)description : description option;A brief description of the state template.
*)name : resource_name;The name of the state template.
*)}type nonrec create_signal_catalog_response = {arn : arn;The ARN of the created signal catalog.
*)name : resource_name;The name of the created signal catalog.
*)}type nonrec create_signal_catalog_request = {nodes : nodes option;A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.
*)description : description option;A brief description of the signal catalog.
*)name : resource_name;The name of the signal catalog to create.
*)}type nonrec create_model_manifest_response = {arn : arn;The ARN of the created vehicle model.
*)name : resource_name;The name of the created vehicle model.
*)}type nonrec create_model_manifest_request = {signal_catalog_arn : arn;The Amazon Resource Name (ARN) of a signal catalog.
*)nodes : list_of_strings;A list of nodes, which are a general abstraction of signals.
*)description : description option;A brief description of the vehicle model.
*)name : resource_name;The name of the vehicle model to create.
*)}type nonrec create_fleet_request = {signal_catalog_arn : arn;The Amazon Resource Name (ARN) of a signal catalog.
*)description : description option;A brief description of the fleet to create.
*)fleet_id : fleet_id;The unique ID of the fleet to create.
*)}type nonrec create_decoder_manifest_response = {arn : arn;The ARN of the created decoder manifest.
*)name : resource_name;The name of the created decoder manifest.
*)}type nonrec create_decoder_manifest_request = {default_for_unmapped_signals : default_for_unmapped_signals_type option;Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.
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.
*)network_interfaces : network_interfaces option;A list of information about available network interfaces.
*)signal_decoders : signal_decoders option;A list of information about signal decoders.
*)model_manifest_arn : arn;The Amazon Resource Name (ARN) of the vehicle model (model manifest).
*)description : description option;A brief description of the decoder manifest.
*)name : resource_name;The unique name of the decoder manifest to create.
*)}type nonrec create_campaign_response = {arn : campaign_arn option;The ARN of the created campaign.
*)name : campaign_name option;The name of the created campaign.
*)}type nonrec create_campaign_request = {signals_to_fetch : signal_fetch_information_list option;A list of information about signals to fetch.
*)data_partitions : data_partitions option;The data partitions associated with the signals collected from the vehicle.
*)data_destination_configs : data_destination_configs option;The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.
MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
*)data_extra_dimensions : data_extra_dimension_node_path_list option;A list of vehicle attributes to associate with a campaign.
Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model.
Default: An empty array
*)collection_scheme : collection_scheme;The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.
*)signals_to_collect : signal_information_list option;A list of information about signals to collect.
If you upload a signal as a condition in a data partition for a campaign, then those same signals must be included in signalsToCollect.
priority : priority option;A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used.
Default: 0
compression : compression option;Determines whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If it's not specified, SNAPPY is used.
Default: SNAPPY
spooling_mode : spooling_mode option;Determines whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used.
Default: OFF
diagnostics_mode : diagnostics_mode option;Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS. If it's not specified, OFF is used.
Default: OFF
post_trigger_collection_duration : uint32 option;How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0 is used.
Default: 0
expiry_time : timestamp option;The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires.
Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
*)start_time : timestamp option;The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.
Default: 0
target_arn : arn;The ARN of the vehicle or fleet to deploy a campaign to.
*)signal_catalog_arn : arn;The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
*)description : description option;An optional description of the campaign to help identify its purpose.
*)name : campaign_name;The name of the campaign to create.
*)}type nonrec campaign_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec associate_vehicle_fleet_request = {fleet_id : fleet_id;The ID of a fleet.
*)vehicle_name : vehicle_name;The unique ID of the vehicle to associate with the fleet.
*)}