String fullyQualifiedName
The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be
Vehicle.Front.Left.Door.Lock.
String dataType
The specified data type of the actuator.
String description
A brief description of the actuator.
String unit
The scientific unit for the actuator.
List<E> allowedValues
A list of possible values an actuator can take.
Double min
The specified possible minimum value of an actuator.
Double max
The specified possible maximum value of an actuator.
String assignedValue
A specified value for the actuator.
String deprecationMessage
The deprecation message for the node or the branch that was moved or deleted.
String comment
A comment in addition to the description.
String fullyQualifiedName
The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be
Vehicle.Body.Engine.Type.
String dataType
The specified data type of the attribute.
String description
A brief description of the attribute.
String unit
The scientific unit for the attribute.
List<E> allowedValues
A list of possible values an attribute can be assigned.
Double min
The specified possible minimum value of the attribute.
Double max
The specified possible maximum value of the attribute.
String assignedValue
A specified value for the attribute.
String defaultValue
The default value of the attribute.
String deprecationMessage
The deprecation message for the node or the branch that was moved or deleted.
String comment
A comment in addition to the description.
List<E> vehicles
A list of information about the batch of updated vehicles.
This list contains only unique IDs for the vehicles that were updated.
List<E> errors
A list of information about errors returned while updating a batch of vehicles, or, if there aren't any errors, an empty list.
String fullyQualifiedName
The fully qualified name of the branch. For example, the fully qualified name of a branch might be
Vehicle.Body.Engine.
String description
A brief description of the branch.
String deprecationMessage
The deprecation message for the node or the branch that was moved or deleted.
String comment
A comment in addition to the description.
String arn
The Amazon Resource Name (ARN) of a campaign.
String name
The name of a campaign.
String description
The description of the campaign.
String signalCatalogArn
The ARN of the signal catalog associated with the campaign.
String targetArn
The ARN of a vehicle or fleet to which the campaign is deployed.
String status
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.
Date creationTime
The time the campaign was created.
Date lastModificationTime
The last time the campaign was modified.
String networkInterface
Contains information about a network interface.
List<E> canDbcFiles
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.
Map<K,V> signalsMap
Pairs every signal specified in your vehicle model with a signal decoder.
Integer messageId
The ID of the message.
Boolean isBigEndian
Whether the byte ordering of a CAN message is big-endian.
Boolean isSigned
Whether the message data is specified as a signed value.
Integer startBit
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.
Double offset
The offset used to calculate the signal value. Combined with factor, the calculation is
value = raw_value * factor + offset.
Double factor
A multiplier used to decode the CAN message.
Integer length
How many bytes of data are in the message.
String name
The name of the signal.
TimeBasedCollectionScheme timeBasedCollectionScheme
Information about a collection scheme that uses a time period to decide how often to collect data.
ConditionBasedCollectionScheme conditionBasedCollectionScheme
Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
String expression
The logical expression used to recognize what data to collect. For example,
$variable.Vehicle.OutsideAirTemperature >= 105.0.
Long minimumTriggerIntervalMs
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.
String triggerMode
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.
Integer conditionLanguageVersion
Specifies the version of the conditional expression language.
String name
The name of the campaign to create.
String description
An optional description of the campaign to help identify its purpose.
String signalCatalogArn
(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
String targetArn
The ARN of the vehicle or fleet to deploy a campaign to.
Date startTime
(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified,
0 is used.
Default: 0
Date expiryTime
(Optional) 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)
Long postTriggerCollectionDuration
(Optional) 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
String diagnosticsMode
(Optional) 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
String spoolingMode
(Optional) 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
String compression
(Optional) 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
Integer priority
(Optional) 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
List<E> signalsToCollect
(Optional) A list of information about signals to collect.
CollectionScheme collectionScheme
The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.
List<E> dataExtraDimensions
(Optional) 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
List<E> tags
Metadata that can be used to manage the campaign.
List<E> dataDestinationConfigs
The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
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.
String name
The unique name of the decoder manifest to create.
String description
A brief description of the decoder manifest.
String modelManifestArn
The Amazon Resource Name (ARN) of the vehicle model (model manifest).
List<E> signalDecoders
A list of information about signal decoders.
List<E> networkInterfaces
A list of information about available network interfaces.
List<E> tags
Metadata that can be used to manage the decoder manifest.
String name
The name of the vehicle model to create.
String description
A brief description of the vehicle model.
List<E> nodes
A list of nodes, which are a general abstraction of signals.
String signalCatalogArn
The Amazon Resource Name (ARN) of a signal catalog.
List<E> tags
Metadata that can be used to manage the vehicle model.
String name
The name of the signal catalog to create.
String description
A brief description of the signal catalog.
List<E> nodes
A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.
List<E> tags
Metadata that can be used to manage the signal catalog.
String vehicleName
The unique ID of the vehicle to create.
String modelManifestArn
The Amazon Resource Name ARN of a vehicle model.
String decoderManifestArn
The ARN of a decoder manifest.
Map<K,V> attributes
Static information about a vehicle in a key-value pair. For example: "engineType" :
"1.3 L R2"
A campaign must include the keys (attribute names) in dataExtraDimensions for them to display in
Amazon Timestream.
String associationBehavior
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:
List<E> tags
Metadata that can be used to manage the vehicle.
String vehicleName
The unique ID of the vehicle to create.
String modelManifestArn
The ARN of the vehicle model (model manifest) to create the vehicle from.
String decoderManifestArn
The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
Map<K,V> attributes
Static information about a vehicle in a key-value pair. For example: "engine Type" :
"v6"
String associationBehavior
An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
List<E> tags
Metadata which can be used to manage the vehicle.
S3Config s3Config
The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.
TimestreamConfig timestreamConfig
The Amazon Timestream table where the campaign sends data.
String name
The name of the decoder manifest.
String arn
The ARN of a vehicle model (model manifest) associated with the decoder manifest.
String modelManifestArn
The ARN of a vehicle model (model manifest) associated with the decoder manifest.
String description
A brief description of the decoder manifest.
String status
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.
Date creationTime
The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
Date lastModificationTime
The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
String name
The name of the campaign to delete.
String name
The name of the decoder manifest to delete.
String fleetId
The ID of the fleet to delete.
String name
The name of the model manifest to delete.
String name
The name of the signal catalog to delete.
String vehicleName
The ID of the vehicle to delete.
String id
The unique ID of the fleet.
String arn
The Amazon Resource Name (ARN) of the fleet.
String description
A brief description of the fleet.
String signalCatalogArn
The ARN of the signal catalog associated with the fleet.
Date creationTime
The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
Date lastModificationTime
The time the fleet was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
String vssJson
Provides the VSS in JSON format.
String name
The name of the campaign to retrieve information about.
String name
The name of the campaign.
String arn
The Amazon Resource Name (ARN) of the campaign.
String description
The description of the campaign.
String signalCatalogArn
The ARN of a signal catalog.
String targetArn
The ARN of the vehicle or the fleet targeted by the campaign.
String status
The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL,
RUNNING, and SUSPENDED.
Date startTime
The time, in milliseconds, to deliver a campaign after it was approved.
Date expiryTime
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.
Long postTriggerCollectionDuration
How long (in seconds) to collect raw data after a triggering event initiates the collection.
String diagnosticsMode
Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
String spoolingMode
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.
String compression
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.
Integer priority
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.
List<E> signalsToCollect
Information about a list of signals to collect data on.
CollectionScheme collectionScheme
Information about the data collection scheme associated with the campaign.
List<E> dataExtraDimensions
A list of vehicle attributes associated with the campaign.
Date creationTime
The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
Date lastModificationTime
The last time the campaign was modified.
List<E> dataDestinationConfigs
The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
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.
String name
The name of the decoder manifest to retrieve information about.
String name
The name of the decoder manifest.
String arn
The Amazon Resource Name (ARN) of the decoder manifest.
String description
A brief description of the decoder manifest.
String modelManifestArn
The ARN of a vehicle model (model manifest) associated with the decoder manifest.
String status
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.
Date creationTime
The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
Date lastModificationTime
The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
String fleetId
The ID of the fleet to retrieve information about.
String id
The ID of the fleet.
String arn
The Amazon Resource Name (ARN) of the fleet.
String description
A brief description of the fleet.
String signalCatalogArn
The ARN of a signal catalog associated with the fleet.
Date creationTime
The time the fleet was created in seconds since epoch (January 1, 1970 at midnight UTC time).
Date lastModificationTime
The time the fleet was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
CloudWatchLogDeliveryOptions cloudWatchLogDelivery
Returns information about log delivery to Amazon CloudWatch Logs.
String name
The name of the vehicle model to retrieve information about.
String name
The name of the vehicle model.
String arn
The Amazon Resource Name (ARN) of the vehicle model.
String description
A brief description of the vehicle model.
String signalCatalogArn
The ARN of the signal catalog associated with the vehicle model.
String status
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.
Date creationTime
The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
Date lastModificationTime
The last time the vehicle model was modified.
String customerAccountId
The unique ID of the Amazon Web Services account, provided at account creation.
String accountStatus
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.
TimestreamRegistrationResponse timestreamRegistrationResponse
Information about the registered Amazon Timestream resources or errors, if any.
IamRegistrationResponse iamRegistrationResponse
Information about the registered IAM resources or errors, if any.
Date creationTime
The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).
Date lastModificationTime
The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
String name
The name of the signal catalog to retrieve information about.
String name
The name of the signal catalog.
String arn
The Amazon Resource Name (ARN) of the signal catalog.
String description
A brief description of the signal catalog.
NodeCounts nodeCounts
The total number of network nodes specified in a signal catalog.
Date creationTime
The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
Date lastModificationTime
The last time the signal catalog was modified.
String vehicleName
The ID of the vehicle to retrieve information about.
String vehicleName
The ID of the vehicle.
String arn
The Amazon Resource Name (ARN) of the vehicle to retrieve information about.
String modelManifestArn
The ARN of a vehicle model (model manifest) associated with the vehicle.
String decoderManifestArn
The ARN of a decoder manifest associated with the vehicle.
Map<K,V> attributes
Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
Date creationTime
The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
Date lastModificationTime
The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
String nextToken
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.
Integer maxResults
The maximum number of items to return, between 1 and 100, inclusive.
String vehicleName
The ID of the vehicle to retrieve information about.
String roleArn
The Amazon Resource Name (ARN) of the IAM role to register.
String registrationStatus
The status of registering your IAM resource. The status can be one of REGISTRATION_SUCCESS,
REGISTRATION_PENDING, REGISTRATION_FAILURE.
String errorMessage
A message associated with a registration error.
String roleArn
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.
String name
The name of the signal catalog to import.
String description
A brief description of the signal catalog.
FormattedVss vss
The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise language used to describe and model signals in vehicle networks.
List<E> tags
Metadata that can be used to manage the signal catalog.
Integer retryAfterSeconds
The number of seconds to wait before retrying the command.
String nextToken
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.
Integer maxResults
The maximum number of items to return, between 1 and 100, inclusive.
String status
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.
String name
The name of the decoder manifest to list information about.
String nextToken
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.
Integer maxResults
The maximum number of items to return, between 1 and 100, inclusive.
String name
The name of the decoder manifest to list information about.
String nextToken
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.
Integer maxResults
The maximum number of items to return, between 1 and 100, inclusive.
String modelManifestArn
The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
String nextToken
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.
Integer maxResults
The maximum number of items to return, between 1 and 100, inclusive.
String vehicleName
The ID of the vehicle to retrieve information about.
String nextToken
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.
Integer maxResults
The maximum number of items to return, between 1 and 100, inclusive.
String nextToken
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.
Integer maxResults
The maximum number of items to return, between 1 and 100, inclusive.
String name
The name of the vehicle model to list information about.
String nextToken
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.
Integer maxResults
The maximum number of items to return, between 1 and 100, inclusive.
String signalCatalogArn
The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned.
String nextToken
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.
Integer maxResults
The maximum number of items to return, between 1 and 100, inclusive.
String name
The name of the signal catalog to list information about.
String nextToken
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.
Integer maxResults
The maximum number of items to return, between 1 and 100, inclusive.
String nextToken
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.
Integer maxResults
The maximum number of items to return, between 1 and 100, inclusive.
String resourceARN
The ARN of the resource.
String fleetId
The ID of a fleet.
String nextToken
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.
Integer maxResults
The maximum number of items to return, between 1 and 100, inclusive.
String modelManifestArn
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.
String nextToken
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.
Integer maxResults
The maximum number of items to return, between 1 and 100, inclusive.
String name
The name of the vehicle model.
String arn
The Amazon Resource Name (ARN) of the vehicle model.
String signalCatalogArn
The ARN of the signal catalog associated with the vehicle model.
String description
A brief description of the vehicle model.
String status
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.
Date creationTime
The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
Date lastModificationTime
The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
CanDbcDefinition canDbc
Information, including CAN DBC files, about the configurations used to create a decoder manifest.
String interfaceId
The ID of the network interface.
String 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.
CanInterface canInterface
Information about a network interface specified by the Controller Area Network (CAN) protocol.
ObdInterface obdInterface
Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
Branch branch
Information about a node specified as a branch.
A group of signals that are defined in a hierarchical structure.
Sensor sensor
Actuator actuator
Information about a node specified as an actuator.
An actuator is a digital representation of a vehicle device.
Attribute attribute
Information about a node specified as an attribute.
An attribute represents static information about a vehicle.
Integer totalNodes
The total number of nodes in a vehicle network.
Integer totalBranches
The total number of nodes in a vehicle network that represent branches.
Integer totalSensors
The total number of nodes in a vehicle network that represent sensors.
Integer totalAttributes
The total number of nodes in a vehicle network that represent attributes.
Integer totalActuators
The total number of nodes in a vehicle network that represent actuators.
String name
The name of the interface.
Integer requestMessageId
The ID of the message requesting vehicle data.
String obdStandard
The standard OBD II PID.
Integer pidRequestIntervalSeconds
The maximum number message requests per second.
Integer dtcRequestIntervalSeconds
The maximum number message requests per diagnostic trouble code per second.
Boolean useExtendedIds
Whether to use extended IDs in the message.
Boolean hasTransmissionEcu
Whether the vehicle has a transmission control module (TCM).
Integer pidResponseLength
The length of the requested data.
Integer serviceMode
The mode of operation (diagnostic service) in a message.
Integer pid
The diagnostic code used to request data from a vehicle for this signal.
Double scaling
A multiplier used to decode the message.
Double offset
The offset used to calculate the signal value. Combined with scaling, the calculation is
value = raw_value * scaling + offset.
Integer startByte
Indicates the beginning of the message.
Integer byteLength
The length of a message.
Integer bitRightShift
The number of positions to shift bits in the message.
Integer bitMaskLength
The number of bits to mask in a message.
CloudWatchLogDeliveryOptions cloudWatchLogDelivery
Creates or updates the log delivery option to Amazon CloudWatch Logs.
TimestreamResources timestreamResources
IamResources iamResources
The IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.
String registerAccountStatus
The status of registering your Amazon Web Services account, IAM role, and Timestream resources.
TimestreamResources timestreamResources
IamResources iamResources
The registered IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.
Date creationTime
The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).
Date lastModificationTime
The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
String bucketArn
The Amazon Resource Name (ARN) of the Amazon S3 bucket.
String dataFormat
Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.
Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
JSON - Store data in a standard text-based JSON file format.
String storageCompressionFormat
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.
String prefix
(Optional) 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/.
String fullyQualifiedName
The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be
Vehicle.Body.Engine.Battery.
String dataType
The specified data type of the sensor.
String description
A brief description of a sensor.
String unit
The scientific unit of measurement for data collected by the sensor.
List<E> allowedValues
A list of possible values a sensor can take.
Double min
The specified possible minimum value of the sensor.
Double max
The specified possible maximum value of the sensor.
String deprecationMessage
The deprecation message for the node or the branch that was moved or deleted.
String comment
A comment in addition to the description.
String name
The name of the signal catalog.
String arn
The Amazon Resource Name (ARN) of the signal catalog.
Date creationTime
The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
Date lastModificationTime
The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
String fullyQualifiedName
The fully qualified name of a signal decoder as defined in a vehicle model.
String 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.
String interfaceId
The ID of a network interface that specifies what network protocol a vehicle follows.
CanSignal canSignal
Information about signal decoder using the Controller Area Network (CAN) protocol.
ObdSignal obdSignal
Information about signal decoder using the On-board diagnostic (OBD) II protocol.
String name
The name of the signal.
Long maxSampleCount
The maximum number of samples to collect.
Long minimumSamplingIntervalMs
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.
String quotaCode
The quota identifier of the applied throttling rules for this request.
String serviceCode
The code for the service that couldn't be completed due to throttling.
Integer retryAfterSeconds
The number of seconds to wait before retrying the command.
Long periodMs
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.
String timestreamTableArn
The Amazon Resource Name (ARN) of the Amazon Timestream table.
String executionRoleArn
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.
String timestreamDatabaseName
The name of the Timestream database.
String timestreamTableName
The name of the Timestream database table.
String timestreamDatabaseArn
The Amazon Resource Name (ARN) of the Timestream database.
String timestreamTableArn
The ARN of the Timestream database table.
String registrationStatus
The status of registering your Amazon Timestream resources. The status can be one of
REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.
String errorMessage
A message associated with a registration error.
String name
The name of the campaign to update.
String description
The description of the campaign.
List<E> dataExtraDimensions
A list of vehicle attributes to associate with a signal.
Default: An empty array
String 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.
String arn
The Amazon Resource Name (ARN) of the campaign.
String name
The name of the updated campaign.
String status
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 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.
String name
The name of the decoder manifest to update.
String description
A brief description of the decoder manifest to update.
List<E> signalDecodersToAdd
A list of information about decoding additional signals to add to the decoder manifest.
List<E> signalDecodersToUpdate
A list of updated information about decoding signals to update in the decoder manifest.
List<E> signalDecodersToRemove
A list of signal decoders to remove from the decoder manifest.
List<E> networkInterfacesToAdd
A list of information about the network interfaces to add to the decoder manifest.
List<E> networkInterfacesToUpdate
A list of information about the network interfaces to update in the decoder manifest.
List<E> networkInterfacesToRemove
A list of network interfaces to remove from the decoder manifest.
String status
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.
String name
The name of the vehicle model to update.
String description
A brief description of the vehicle model.
List<E> nodesToAdd
A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to add to the
vehicle model.
List<E> nodesToRemove
A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to remove from
the vehicle model.
String status
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.
String name
The name of the signal catalog to update.
String description
A brief description of the signal catalog to update.
List<E> nodesToAdd
A list of information about nodes to add to the signal catalog.
List<E> nodesToUpdate
A list of information about nodes to update in the signal catalog.
List<E> nodesToRemove
A list of fullyQualifiedName of nodes to remove from the signal catalog.
String vehicleName
The unique ID of the vehicle to update.
String modelManifestArn
The ARN of a vehicle model (model manifest) associated with the vehicle.
String decoderManifestArn
The ARN of the decoder manifest associated with this vehicle.
Map<K,V> attributes
Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
String attributeUpdateMode
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.
String vehicleName
The unique ID of the vehicle to update.
String modelManifestArn
The ARN of the vehicle model (model manifest) associated with the vehicle to update.
String decoderManifestArn
The ARN of the signal decoder manifest associated with the vehicle to update.
Map<K,V> attributes
Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
String attributeUpdateMode
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.
String campaignName
The name of a campaign.
String vehicleName
The unique ID of the vehicle.
String status
The state of a vehicle, which can be one of the following:
CREATED - Amazon Web Services IoT FleetWise sucessfully created the vehicle.
READY - The vehicle is ready to receive a campaign deployment.
HEALTHY - A campaign deployment was delivered to the vehicle.
SUSPENDED - A campaign associated with the vehicle was suspended and data collection was paused.
DELETING - Amazon Web Services IoT FleetWise is removing a campaign from the vehicle.
String vehicleName
The unique ID of the vehicle.
String arn
The Amazon Resource Name (ARN) of the vehicle.
String modelManifestArn
The ARN of a vehicle model (model manifest) associated with the vehicle.
String decoderManifestArn
The ARN of a decoder manifest associated with the vehicle.
Date creationTime
The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
Date lastModificationTime
The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
Copyright © 2023. All rights reserved.