2023/11/27 - AWS IoT FleetWise - 14 updated api methods
Changes AWS IoT FleetWise introduces new APIs for vision system data, such as data collected from cameras, radars, and lidars. You can now model and decode complex data types.
{'networkInterfaces': {'type': {'CUSTOMER_DECODED_INTERFACE',
'VEHICLE_MIDDLEWARE'},
'vehicleMiddleware': {'name': 'string',
'protocolName': 'ROS_2'}},
'signalDecoders': {'messageSignal': {'structuredMessage': {'primitiveMessageDefinition': {'ros2PrimitiveMessageDefinition': {'offset': 'double',
'primitiveType': 'BOOL '
'| '
'BYTE '
'| '
'CHAR '
'| '
'FLOAT32 '
'| '
'FLOAT64 '
'| '
'INT8 '
'| '
'UINT8 '
'| '
'INT16 '
'| '
'UINT16 '
'| '
'INT32 '
'| '
'UINT32 '
'| '
'INT64 '
'| '
'UINT64 '
'| '
'STRING '
'| '
'WSTRING',
'scaling': 'double',
'upperBound': 'long'}},
'structuredMessageDefinition': [{'dataType': (),
'fieldName': 'string'}],
'structuredMessageListDefinition': {'capacity': 'integer',
'listType': 'FIXED_CAPACITY '
'| '
'DYNAMIC_UNBOUNDED_CAPACITY '
'| '
'DYNAMIC_BOUNDED_CAPACITY',
'memberType': (),
'name': 'string'}},
'topicName': 'string'},
'type': {'CUSTOMER_DECODED_SIGNAL', 'MESSAGE_SIGNAL'}}}
Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true:
Every signal decoder has a unique name.
Each signal decoder is associated with a network interface.
Each network interface has a unique ID.
The signal decoders are specified in the model manifest.
See also: AWS API Documentation
Request Syntax
client.create_decoder_manifest(
name='string',
description='string',
modelManifestArn='string',
signalDecoders=[
{
'fullyQualifiedName': 'string',
'type': 'CAN_SIGNAL'|'OBD_SIGNAL'|'MESSAGE_SIGNAL'|'CUSTOMER_DECODED_SIGNAL',
'interfaceId': 'string',
'canSignal': {
'messageId': 123,
'isBigEndian': True|False,
'isSigned': True|False,
'startBit': 123,
'offset': 123.0,
'factor': 123.0,
'length': 123,
'name': 'string'
},
'obdSignal': {
'pidResponseLength': 123,
'serviceMode': 123,
'pid': 123,
'scaling': 123.0,
'offset': 123.0,
'startByte': 123,
'byteLength': 123,
'bitRightShift': 123,
'bitMaskLength': 123
},
'messageSignal': {
'topicName': 'string',
'structuredMessage': {
'primitiveMessageDefinition': {
'ros2PrimitiveMessageDefinition': {
'primitiveType': 'BOOL'|'BYTE'|'CHAR'|'FLOAT32'|'FLOAT64'|'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'STRING'|'WSTRING',
'offset': 123.0,
'scaling': 123.0,
'upperBound': 123
}
},
'structuredMessageListDefinition': {
'name': 'string',
'memberType': {'... recursive ...'},
'listType': 'FIXED_CAPACITY'|'DYNAMIC_UNBOUNDED_CAPACITY'|'DYNAMIC_BOUNDED_CAPACITY',
'capacity': 123
},
'structuredMessageDefinition': [
{
'fieldName': 'string',
'dataType': {'... recursive ...'}
},
]
}
}
},
],
networkInterfaces=[
{
'interfaceId': 'string',
'type': 'CAN_INTERFACE'|'OBD_INTERFACE'|'VEHICLE_MIDDLEWARE'|'CUSTOMER_DECODED_INTERFACE',
'canInterface': {
'name': 'string',
'protocolName': 'string',
'protocolVersion': 'string'
},
'obdInterface': {
'name': 'string',
'requestMessageId': 123,
'obdStandard': 'string',
'pidRequestIntervalSeconds': 123,
'dtcRequestIntervalSeconds': 123,
'useExtendedIds': True|False,
'hasTransmissionEcu': True|False
},
'vehicleMiddleware': {
'name': 'string',
'protocolName': 'ROS_2'
}
},
],
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The unique name of the decoder manifest to create.
string
A brief description of the decoder manifest.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the vehicle model (model manifest).
list
A list of information about signal decoders.
(dict) --
Information about a signal decoder.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of a signal decoder as defined in a vehicle model.
type (string) -- [REQUIRED]
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.
interfaceId (string) -- [REQUIRED]
The ID of a network interface that specifies what network protocol a vehicle follows.
canSignal (dict) --
Information about signal decoder using the Controller Area Network (CAN) protocol.
messageId (integer) -- [REQUIRED]
The ID of the message.
isBigEndian (boolean) -- [REQUIRED]
Whether the byte ordering of a CAN message is big-endian.
isSigned (boolean) -- [REQUIRED]
Whether the message data is specified as a signed value.
startBit (integer) -- [REQUIRED]
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 .
offset (float) -- [REQUIRED]
The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset .
factor (float) -- [REQUIRED]
A multiplier used to decode the CAN message.
length (integer) -- [REQUIRED]
How many bytes of data are in the message.
name (string) --
The name of the signal.
obdSignal (dict) --
Information about signal decoder using the On-board diagnostic (OBD) II protocol.
pidResponseLength (integer) -- [REQUIRED]
The length of the requested data.
serviceMode (integer) -- [REQUIRED]
The mode of operation (diagnostic service) in a message.
pid (integer) -- [REQUIRED]
The diagnostic code used to request data from a vehicle for this signal.
scaling (float) -- [REQUIRED]
A multiplier used to decode the message.
offset (float) -- [REQUIRED]
The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset .
startByte (integer) -- [REQUIRED]
Indicates the beginning of the message.
byteLength (integer) -- [REQUIRED]
The length of a message.
bitRightShift (integer) --
The number of positions to shift bits in the message.
bitMaskLength (integer) --
The number of bits to mask in a message.
messageSignal (dict) --
The decoding information for a specific message which supports higher order data types.
topicName (string) -- [REQUIRED]
The topic name for the message signal. It corresponds to topics in ROS 2.
structuredMessage (dict) -- [REQUIRED]
The structured message for the message signal. It can be defined with either a primitiveMessageDefinition , structuredMessageListDefinition , or structuredMessageDefinition recursively.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.
primitiveMessageDefinition (dict) --
Represents a primitive type node of the complex data structure.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ros2PrimitiveMessageDefinition.
ros2PrimitiveMessageDefinition (dict) --
Information about a PrimitiveMessage using a ROS 2 compliant primitive type message of the complex data structure.
primitiveType (string) -- [REQUIRED]
The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.
offset (float) --
The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset .
scaling (float) --
A multiplier used to decode the message.
upperBound (integer) --
An optional attribute specifying the upper bound for STRING and WSTRING .
structuredMessageListDefinition (dict) --
Represents a list type node of the complex data structure.
name (string) -- [REQUIRED]
The name of the structured message list definition.
memberType (dict) --
The member type of the structured message list definition.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.
listType (string) -- [REQUIRED]
The type of list of the structured message list definition.
capacity (integer) --
The capacity of the structured message list definition when the list type is FIXED_CAPACITY or DYNAMIC_BOUNDED_CAPACITY .
structuredMessageDefinition (list) --
Represents a struct type node of the complex data structure.
(dict) --
Represents a StructureMessageName to DataType map element.
fieldName (string) -- [REQUIRED]
The field name of the structured message. It determines how a data value is referenced in the target language.
dataType (dict) --
The data type.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.
list
A list of information about available network interfaces.
(dict) --
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.
interfaceId (string) -- [REQUIRED]
The ID of the network interface.
type (string) -- [REQUIRED]
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 (dict) --
Information about a network interface specified by the Controller Area Network (CAN) protocol.
name (string) -- [REQUIRED]
The unique name of the interface.
protocolName (string) --
The name of the communication protocol for the interface.
protocolVersion (string) --
The version of the communication protocol for the interface.
obdInterface (dict) --
Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
name (string) -- [REQUIRED]
The name of the interface.
requestMessageId (integer) -- [REQUIRED]
The ID of the message requesting vehicle data.
obdStandard (string) --
The standard OBD II PID.
pidRequestIntervalSeconds (integer) --
The maximum number message requests per second.
dtcRequestIntervalSeconds (integer) --
The maximum number message requests per diagnostic trouble code per second.
useExtendedIds (boolean) --
Whether to use extended IDs in the message.
hasTransmissionEcu (boolean) --
Whether the vehicle has a transmission control module (TCM).
vehicleMiddleware (dict) --
The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP .
name (string) -- [REQUIRED]
The name of the vehicle middleware.
protocolName (string) -- [REQUIRED]
The protocol name of the vehicle middleware.
list
Metadata that can be used to manage the decoder manifest.
(dict) --
A set of key/value pairs that are used to manage the resource.
Key (string) -- [REQUIRED]
The tag's key.
Value (string) -- [REQUIRED]
The tag's value.
dict
Response Syntax
{
'name': 'string',
'arn': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the created decoder manifest.
arn (string) --
The ARN of the created decoder manifest.
{'nodes': {'actuator': {'dataType': {'STRUCT_ARRAY', 'STRUCT'},
'structFullyQualifiedName': 'string'},
'attribute': {'dataType': {'STRUCT_ARRAY', 'STRUCT'}},
'property': {'comment': 'string',
'dataEncoding': 'BINARY | TYPED',
'dataType': 'INT8 | UINT8 | INT16 | UINT16 | INT32 | '
'UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT '
'| DOUBLE | STRING | UNIX_TIMESTAMP | '
'INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | '
'UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY '
'| INT64_ARRAY | UINT64_ARRAY | '
'BOOLEAN_ARRAY | FLOAT_ARRAY | '
'DOUBLE_ARRAY | STRING_ARRAY | '
'UNIX_TIMESTAMP_ARRAY | UNKNOWN | STRUCT | '
'STRUCT_ARRAY',
'deprecationMessage': 'string',
'description': 'string',
'fullyQualifiedName': 'string',
'structFullyQualifiedName': 'string'},
'sensor': {'dataType': {'STRUCT_ARRAY', 'STRUCT'},
'structFullyQualifiedName': 'string'},
'struct': {'comment': 'string',
'deprecationMessage': 'string',
'description': 'string',
'fullyQualifiedName': 'string'}}}
Creates a collection of standardized signals that can be reused to create vehicle models.
See also: AWS API Documentation
Request Syntax
client.create_signal_catalog(
name='string',
description='string',
nodes=[
{
'branch': {
'fullyQualifiedName': 'string',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'sensor': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
},
'actuator': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'assignedValue': 'string',
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
},
'attribute': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'assignedValue': 'string',
'defaultValue': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'struct': {
'fullyQualifiedName': 'string',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'property': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'dataEncoding': 'BINARY'|'TYPED',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
}
},
],
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the signal catalog to create.
string
A brief description of the signal catalog.
list
A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.
(dict) --
A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: branch, sensor, actuator, attribute, struct, property.
branch (dict) --
Information about a node specified as a branch.
Note
A group of signals that are defined in a hierarchical structure.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the branch. For example, the fully qualified name of a branch might be Vehicle.Body.Engine .
description (string) --
A brief description of the branch.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
sensor (dict) --
An input component that reports the environmental condition of a vehicle.
Note
You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery .
dataType (string) -- [REQUIRED]
The specified data type of the sensor.
description (string) --
A brief description of a sensor.
unit (string) --
The scientific unit of measurement for data collected by the sensor.
allowedValues (list) --
A list of possible values a sensor can take.
(string) --
min (float) --
The specified possible minimum value of the sensor.
max (float) --
The specified possible maximum value of the sensor.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
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 .
actuator (dict) --
Information about a node specified as an actuator.
Note
An actuator is a digital representation of a vehicle device.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock .
dataType (string) -- [REQUIRED]
The specified data type of the actuator.
description (string) --
A brief description of the actuator.
unit (string) --
The scientific unit for the actuator.
allowedValues (list) --
A list of possible values an actuator can take.
(string) --
min (float) --
The specified possible minimum value of an actuator.
max (float) --
The specified possible maximum value of an actuator.
assignedValue (string) --
A specified value for the actuator.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
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 .
attribute (dict) --
Information about a node specified as an attribute.
Note
An attribute represents static information about a vehicle.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type .
dataType (string) -- [REQUIRED]
The specified data type of the attribute.
description (string) --
A brief description of the attribute.
unit (string) --
The scientific unit for the attribute.
allowedValues (list) --
A list of possible values an attribute can be assigned.
(string) --
min (float) --
The specified possible minimum value of the attribute.
max (float) --
The specified possible maximum value of the attribute.
assignedValue (string) --
A specified value for the attribute.
defaultValue (string) --
The default value of the attribute.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
struct (dict) --
Represents a complex or higher-order data structure.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be ComplexDataTypes.VehicleDataTypes.SVMCamera .
description (string) --
A brief description of the custom structure.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
property (dict) --
Represents a member of the complex data structure. The datatype of the property can be either primitive or another struct .
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS .
dataType (string) -- [REQUIRED]
The data type for the custom property.
dataEncoding (string) --
Indicates whether the property is binary data.
description (string) --
A brief description of the custom property.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray .
list
Metadata that can be used to manage the signal catalog.
(dict) --
A set of key/value pairs that are used to manage the resource.
Key (string) -- [REQUIRED]
The tag's key.
Value (string) -- [REQUIRED]
The tag's value.
dict
Response Syntax
{
'name': 'string',
'arn': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the created signal catalog.
arn (string) --
The ARN of the created signal catalog.
{'message': 'string', 'status': {'INVALID', 'VALIDATING'}}
Retrieves information about a created decoder manifest.
See also: AWS API Documentation
Request Syntax
client.get_decoder_manifest(
name='string'
)
string
[REQUIRED]
The name of the decoder manifest to retrieve information about.
dict
Response Syntax
{
'name': 'string',
'arn': 'string',
'description': 'string',
'modelManifestArn': 'string',
'status': 'ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING',
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1),
'message': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the decoder manifest.
arn (string) --
The Amazon Resource Name (ARN) of the decoder manifest.
description (string) --
A brief description of the decoder manifest.
modelManifestArn (string) --
The ARN of a vehicle model (model manifest) associated with the decoder manifest.
status (string) --
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.
creationTime (datetime) --
The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
lastModificationTime (datetime) --
The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
message (string) --
The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information.
{'status': {'INVALID', 'VALIDATING'}}
Retrieves information about a vehicle model (model manifest).
See also: AWS API Documentation
Request Syntax
client.get_model_manifest(
name='string'
)
string
[REQUIRED]
The name of the vehicle model to retrieve information about.
dict
Response Syntax
{
'name': 'string',
'arn': 'string',
'description': 'string',
'signalCatalogArn': 'string',
'status': 'ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING',
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
name (string) --
The name of the vehicle model.
arn (string) --
The Amazon Resource Name (ARN) of the vehicle model.
description (string) --
A brief description of the vehicle model.
signalCatalogArn (string) --
The ARN of the signal catalog associated with the vehicle model.
status (string) --
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 .
creationTime (datetime) --
The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
lastModificationTime (datetime) --
The last time the vehicle model was modified.
{'nodeCounts': {'totalProperties': 'integer', 'totalStructs': 'integer'}}
Retrieves information about a signal catalog.
See also: AWS API Documentation
Request Syntax
client.get_signal_catalog(
name='string'
)
string
[REQUIRED]
The name of the signal catalog to retrieve information about.
dict
Response Syntax
{
'name': 'string',
'arn': 'string',
'description': 'string',
'nodeCounts': {
'totalNodes': 123,
'totalBranches': 123,
'totalSensors': 123,
'totalAttributes': 123,
'totalActuators': 123,
'totalStructs': 123,
'totalProperties': 123
},
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
name (string) --
The name of the signal catalog.
arn (string) --
The Amazon Resource Name (ARN) of the signal catalog.
description (string) --
A brief description of the signal catalog.
nodeCounts (dict) --
The total number of network nodes specified in a signal catalog.
totalNodes (integer) --
The total number of nodes in a vehicle network.
totalBranches (integer) --
The total number of nodes in a vehicle network that represent branches.
totalSensors (integer) --
The total number of nodes in a vehicle network that represent sensors.
totalAttributes (integer) --
The total number of nodes in a vehicle network that represent attributes.
totalActuators (integer) --
The total number of nodes in a vehicle network that represent actuators.
totalStructs (integer) --
The total structure for the node.
totalProperties (integer) --
The total properties for the node.
creationTime (datetime) --
The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
lastModificationTime (datetime) --
The last time the signal catalog was modified.
{'networkInterfaces': {'type': {'CUSTOMER_DECODED_INTERFACE',
'VEHICLE_MIDDLEWARE'},
'vehicleMiddleware': {'name': 'string',
'protocolName': 'ROS_2'}}}
Lists the network interfaces specified in a decoder manifest.
Note
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
See also: AWS API Documentation
Request Syntax
client.list_decoder_manifest_network_interfaces(
name='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The name of the decoder manifest to list information about.
string
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
The maximum number of items to return, between 1 and 100, inclusive.
dict
Response Syntax
{
'networkInterfaces': [
{
'interfaceId': 'string',
'type': 'CAN_INTERFACE'|'OBD_INTERFACE'|'VEHICLE_MIDDLEWARE'|'CUSTOMER_DECODED_INTERFACE',
'canInterface': {
'name': 'string',
'protocolName': 'string',
'protocolVersion': 'string'
},
'obdInterface': {
'name': 'string',
'requestMessageId': 123,
'obdStandard': 'string',
'pidRequestIntervalSeconds': 123,
'dtcRequestIntervalSeconds': 123,
'useExtendedIds': True|False,
'hasTransmissionEcu': True|False
},
'vehicleMiddleware': {
'name': 'string',
'protocolName': 'ROS_2'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
networkInterfaces (list) --
A list of information about network interfaces.
(dict) --
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.
interfaceId (string) --
The ID of the network interface.
type (string) --
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 (dict) --
Information about a network interface specified by the Controller Area Network (CAN) protocol.
name (string) --
The unique name of the interface.
protocolName (string) --
The name of the communication protocol for the interface.
protocolVersion (string) --
The version of the communication protocol for the interface.
obdInterface (dict) --
Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
name (string) --
The name of the interface.
requestMessageId (integer) --
The ID of the message requesting vehicle data.
obdStandard (string) --
The standard OBD II PID.
pidRequestIntervalSeconds (integer) --
The maximum number message requests per second.
dtcRequestIntervalSeconds (integer) --
The maximum number message requests per diagnostic trouble code per second.
useExtendedIds (boolean) --
Whether to use extended IDs in the message.
hasTransmissionEcu (boolean) --
Whether the vehicle has a transmission control module (TCM).
vehicleMiddleware (dict) --
The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP .
name (string) --
The name of the vehicle middleware.
protocolName (string) --
The protocol name of the vehicle middleware.
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
{'signalDecoders': {'messageSignal': {'structuredMessage': {'primitiveMessageDefinition': {'ros2PrimitiveMessageDefinition': {'offset': 'double',
'primitiveType': 'BOOL '
'| '
'BYTE '
'| '
'CHAR '
'| '
'FLOAT32 '
'| '
'FLOAT64 '
'| '
'INT8 '
'| '
'UINT8 '
'| '
'INT16 '
'| '
'UINT16 '
'| '
'INT32 '
'| '
'UINT32 '
'| '
'INT64 '
'| '
'UINT64 '
'| '
'STRING '
'| '
'WSTRING',
'scaling': 'double',
'upperBound': 'long'}},
'structuredMessageDefinition': [{'dataType': (),
'fieldName': 'string'}],
'structuredMessageListDefinition': {'capacity': 'integer',
'listType': 'FIXED_CAPACITY '
'| '
'DYNAMIC_UNBOUNDED_CAPACITY '
'| '
'DYNAMIC_BOUNDED_CAPACITY',
'memberType': (),
'name': 'string'}},
'topicName': 'string'},
'type': {'CUSTOMER_DECODED_SIGNAL', 'MESSAGE_SIGNAL'}}}
A list of information about signal decoders specified in a decoder manifest.
Note
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
See also: AWS API Documentation
Request Syntax
client.list_decoder_manifest_signals(
name='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The name of the decoder manifest to list information about.
string
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
The maximum number of items to return, between 1 and 100, inclusive.
dict
Response Syntax
{
'signalDecoders': [
{
'fullyQualifiedName': 'string',
'type': 'CAN_SIGNAL'|'OBD_SIGNAL'|'MESSAGE_SIGNAL'|'CUSTOMER_DECODED_SIGNAL',
'interfaceId': 'string',
'canSignal': {
'messageId': 123,
'isBigEndian': True|False,
'isSigned': True|False,
'startBit': 123,
'offset': 123.0,
'factor': 123.0,
'length': 123,
'name': 'string'
},
'obdSignal': {
'pidResponseLength': 123,
'serviceMode': 123,
'pid': 123,
'scaling': 123.0,
'offset': 123.0,
'startByte': 123,
'byteLength': 123,
'bitRightShift': 123,
'bitMaskLength': 123
},
'messageSignal': {
'topicName': 'string',
'structuredMessage': {
'primitiveMessageDefinition': {
'ros2PrimitiveMessageDefinition': {
'primitiveType': 'BOOL'|'BYTE'|'CHAR'|'FLOAT32'|'FLOAT64'|'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'STRING'|'WSTRING',
'offset': 123.0,
'scaling': 123.0,
'upperBound': 123
}
},
'structuredMessageListDefinition': {
'name': 'string',
'memberType': {'... recursive ...'},
'listType': 'FIXED_CAPACITY'|'DYNAMIC_UNBOUNDED_CAPACITY'|'DYNAMIC_BOUNDED_CAPACITY',
'capacity': 123
},
'structuredMessageDefinition': [
{
'fieldName': 'string',
'dataType': {'... recursive ...'}
},
]
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
signalDecoders (list) --
Information about a list of signals to decode.
(dict) --
Information about a signal decoder.
fullyQualifiedName (string) --
The fully qualified name of a signal decoder as defined in a vehicle model.
type (string) --
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.
interfaceId (string) --
The ID of a network interface that specifies what network protocol a vehicle follows.
canSignal (dict) --
Information about signal decoder using the Controller Area Network (CAN) protocol.
messageId (integer) --
The ID of the message.
isBigEndian (boolean) --
Whether the byte ordering of a CAN message is big-endian.
isSigned (boolean) --
Whether the message data is specified as a signed value.
startBit (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 .
offset (float) --
The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset .
factor (float) --
A multiplier used to decode the CAN message.
length (integer) --
How many bytes of data are in the message.
name (string) --
The name of the signal.
obdSignal (dict) --
Information about signal decoder using the On-board diagnostic (OBD) II protocol.
pidResponseLength (integer) --
The length of the requested data.
serviceMode (integer) --
The mode of operation (diagnostic service) in a message.
pid (integer) --
The diagnostic code used to request data from a vehicle for this signal.
scaling (float) --
A multiplier used to decode the message.
offset (float) --
The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset .
startByte (integer) --
Indicates the beginning of the message.
byteLength (integer) --
The length of a message.
bitRightShift (integer) --
The number of positions to shift bits in the message.
bitMaskLength (integer) --
The number of bits to mask in a message.
messageSignal (dict) --
The decoding information for a specific message which supports higher order data types.
topicName (string) --
The topic name for the message signal. It corresponds to topics in ROS 2.
structuredMessage (dict) --
The structured message for the message signal. It can be defined with either a primitiveMessageDefinition , structuredMessageListDefinition , or structuredMessageDefinition recursively.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
primitiveMessageDefinition (dict) --
Represents a primitive type node of the complex data structure.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: ros2PrimitiveMessageDefinition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
ros2PrimitiveMessageDefinition (dict) --
Information about a PrimitiveMessage using a ROS 2 compliant primitive type message of the complex data structure.
primitiveType (string) --
The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.
offset (float) --
The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset .
scaling (float) --
A multiplier used to decode the message.
upperBound (integer) --
An optional attribute specifying the upper bound for STRING and WSTRING .
structuredMessageListDefinition (dict) --
Represents a list type node of the complex data structure.
name (string) --
The name of the structured message list definition.
memberType (dict) --
The member type of the structured message list definition.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
listType (string) --
The type of list of the structured message list definition.
capacity (integer) --
The capacity of the structured message list definition when the list type is FIXED_CAPACITY or DYNAMIC_BOUNDED_CAPACITY .
structuredMessageDefinition (list) --
Represents a struct type node of the complex data structure.
(dict) --
Represents a StructureMessageName to DataType map element.
fieldName (string) --
The field name of the structured message. It determines how a data value is referenced in the target language.
dataType (dict) --
The data type.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
{'summaries': {'message': 'string', 'status': {'INVALID', 'VALIDATING'}}}
Lists decoder manifests.
Note
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
See also: AWS API Documentation
Request Syntax
client.list_decoder_manifests(
modelManifestArn='string',
nextToken='string',
maxResults=123
)
string
The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
string
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
The maximum number of items to return, between 1 and 100, inclusive.
dict
Response Syntax
{
'summaries': [
{
'name': 'string',
'arn': 'string',
'modelManifestArn': 'string',
'description': 'string',
'status': 'ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING',
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1),
'message': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
summaries (list) --
A list of information about each decoder manifest.
(dict) --
Information about a created decoder manifest. You can use the API operation to return this information about multiple decoder manifests.
name (string) --
The name of the decoder manifest.
arn (string) --
The ARN of a vehicle model (model manifest) associated with the decoder manifest.
modelManifestArn (string) --
The ARN of a vehicle model (model manifest) associated with the decoder manifest.
description (string) --
A brief description of the decoder manifest.
status (string) --
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.
creationTime (datetime) --
The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
lastModificationTime (datetime) --
The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
message (string) --
The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information.
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
{'nodes': {'actuator': {'dataType': {'STRUCT_ARRAY', 'STRUCT'},
'structFullyQualifiedName': 'string'},
'attribute': {'dataType': {'STRUCT_ARRAY', 'STRUCT'}},
'property': {'comment': 'string',
'dataEncoding': 'BINARY | TYPED',
'dataType': 'INT8 | UINT8 | INT16 | UINT16 | INT32 | '
'UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT '
'| DOUBLE | STRING | UNIX_TIMESTAMP | '
'INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | '
'UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY '
'| INT64_ARRAY | UINT64_ARRAY | '
'BOOLEAN_ARRAY | FLOAT_ARRAY | '
'DOUBLE_ARRAY | STRING_ARRAY | '
'UNIX_TIMESTAMP_ARRAY | UNKNOWN | STRUCT | '
'STRUCT_ARRAY',
'deprecationMessage': 'string',
'description': 'string',
'fullyQualifiedName': 'string',
'structFullyQualifiedName': 'string'},
'sensor': {'dataType': {'STRUCT_ARRAY', 'STRUCT'},
'structFullyQualifiedName': 'string'},
'struct': {'comment': 'string',
'deprecationMessage': 'string',
'description': 'string',
'fullyQualifiedName': 'string'}}}
Lists information about nodes specified in a vehicle model (model manifest).
Note
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
See also: AWS API Documentation
Request Syntax
client.list_model_manifest_nodes(
name='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The name of the vehicle model to list information about.
string
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
The maximum number of items to return, between 1 and 100, inclusive.
dict
Response Syntax
{
'nodes': [
{
'branch': {
'fullyQualifiedName': 'string',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'sensor': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
},
'actuator': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'assignedValue': 'string',
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
},
'attribute': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'assignedValue': 'string',
'defaultValue': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'struct': {
'fullyQualifiedName': 'string',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'property': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'dataEncoding': 'BINARY'|'TYPED',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
nodes (list) --
A list of information about nodes.
(dict) --
A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: branch, sensor, actuator, attribute, struct, property. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
branch (dict) --
Information about a node specified as a branch.
Note
A group of signals that are defined in a hierarchical structure.
fullyQualifiedName (string) --
The fully qualified name of the branch. For example, the fully qualified name of a branch might be Vehicle.Body.Engine .
description (string) --
A brief description of the branch.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
sensor (dict) --
An input component that reports the environmental condition of a vehicle.
Note
You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
fullyQualifiedName (string) --
The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery .
dataType (string) --
The specified data type of the sensor.
description (string) --
A brief description of a sensor.
unit (string) --
The scientific unit of measurement for data collected by the sensor.
allowedValues (list) --
A list of possible values a sensor can take.
(string) --
min (float) --
The specified possible minimum value of the sensor.
max (float) --
The specified possible maximum value of the sensor.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
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 .
actuator (dict) --
Information about a node specified as an actuator.
Note
An actuator is a digital representation of a vehicle device.
fullyQualifiedName (string) --
The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock .
dataType (string) --
The specified data type of the actuator.
description (string) --
A brief description of the actuator.
unit (string) --
The scientific unit for the actuator.
allowedValues (list) --
A list of possible values an actuator can take.
(string) --
min (float) --
The specified possible minimum value of an actuator.
max (float) --
The specified possible maximum value of an actuator.
assignedValue (string) --
A specified value for the actuator.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
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 .
attribute (dict) --
Information about a node specified as an attribute.
Note
An attribute represents static information about a vehicle.
fullyQualifiedName (string) --
The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type .
dataType (string) --
The specified data type of the attribute.
description (string) --
A brief description of the attribute.
unit (string) --
The scientific unit for the attribute.
allowedValues (list) --
A list of possible values an attribute can be assigned.
(string) --
min (float) --
The specified possible minimum value of the attribute.
max (float) --
The specified possible maximum value of the attribute.
assignedValue (string) --
A specified value for the attribute.
defaultValue (string) --
The default value of the attribute.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
struct (dict) --
Represents a complex or higher-order data structure.
fullyQualifiedName (string) --
The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be ComplexDataTypes.VehicleDataTypes.SVMCamera .
description (string) --
A brief description of the custom structure.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
property (dict) --
Represents a member of the complex data structure. The datatype of the property can be either primitive or another struct .
fullyQualifiedName (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 .
dataType (string) --
The data type for the custom property.
dataEncoding (string) --
Indicates whether the property is binary data.
description (string) --
A brief description of the custom property.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray .
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
{'summaries': {'status': {'INVALID', 'VALIDATING'}}}
Retrieves a list of vehicle models (model manifests).
Note
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
See also: AWS API Documentation
Request Syntax
client.list_model_manifests(
signalCatalogArn='string',
nextToken='string',
maxResults=123
)
string
The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned.
string
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
The maximum number of items to return, between 1 and 100, inclusive.
dict
Response Syntax
{
'summaries': [
{
'name': 'string',
'arn': 'string',
'signalCatalogArn': 'string',
'description': 'string',
'status': 'ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING',
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
summaries (list) --
A list of information about vehicle models.
(dict) --
Information about a vehicle model (model manifest). You can use the API operation to return this information about multiple vehicle models.
name (string) --
The name of the vehicle model.
arn (string) --
The Amazon Resource Name (ARN) of the vehicle model.
signalCatalogArn (string) --
The ARN of the signal catalog associated with the vehicle model.
description (string) --
A brief description of the vehicle model.
status (string) --
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.
creationTime (datetime) --
The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
lastModificationTime (datetime) --
The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
{'nodes': {'actuator': {'dataType': {'STRUCT_ARRAY', 'STRUCT'},
'structFullyQualifiedName': 'string'},
'attribute': {'dataType': {'STRUCT_ARRAY', 'STRUCT'}},
'property': {'comment': 'string',
'dataEncoding': 'BINARY | TYPED',
'dataType': 'INT8 | UINT8 | INT16 | UINT16 | INT32 | '
'UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT '
'| DOUBLE | STRING | UNIX_TIMESTAMP | '
'INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | '
'UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY '
'| INT64_ARRAY | UINT64_ARRAY | '
'BOOLEAN_ARRAY | FLOAT_ARRAY | '
'DOUBLE_ARRAY | STRING_ARRAY | '
'UNIX_TIMESTAMP_ARRAY | UNKNOWN | STRUCT | '
'STRUCT_ARRAY',
'deprecationMessage': 'string',
'description': 'string',
'fullyQualifiedName': 'string',
'structFullyQualifiedName': 'string'},
'sensor': {'dataType': {'STRUCT_ARRAY', 'STRUCT'},
'structFullyQualifiedName': 'string'},
'struct': {'comment': 'string',
'deprecationMessage': 'string',
'description': 'string',
'fullyQualifiedName': 'string'}}}
Lists of information about the signals (nodes) specified in a signal catalog.
Note
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
See also: AWS API Documentation
Request Syntax
client.list_signal_catalog_nodes(
name='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The name of the signal catalog to list information about.
string
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
The maximum number of items to return, between 1 and 100, inclusive.
dict
Response Syntax
{
'nodes': [
{
'branch': {
'fullyQualifiedName': 'string',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'sensor': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
},
'actuator': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'assignedValue': 'string',
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
},
'attribute': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'assignedValue': 'string',
'defaultValue': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'struct': {
'fullyQualifiedName': 'string',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'property': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'dataEncoding': 'BINARY'|'TYPED',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
nodes (list) --
A list of information about nodes.
(dict) --
A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: branch, sensor, actuator, attribute, struct, property. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
branch (dict) --
Information about a node specified as a branch.
Note
A group of signals that are defined in a hierarchical structure.
fullyQualifiedName (string) --
The fully qualified name of the branch. For example, the fully qualified name of a branch might be Vehicle.Body.Engine .
description (string) --
A brief description of the branch.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
sensor (dict) --
An input component that reports the environmental condition of a vehicle.
Note
You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
fullyQualifiedName (string) --
The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery .
dataType (string) --
The specified data type of the sensor.
description (string) --
A brief description of a sensor.
unit (string) --
The scientific unit of measurement for data collected by the sensor.
allowedValues (list) --
A list of possible values a sensor can take.
(string) --
min (float) --
The specified possible minimum value of the sensor.
max (float) --
The specified possible maximum value of the sensor.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
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 .
actuator (dict) --
Information about a node specified as an actuator.
Note
An actuator is a digital representation of a vehicle device.
fullyQualifiedName (string) --
The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock .
dataType (string) --
The specified data type of the actuator.
description (string) --
A brief description of the actuator.
unit (string) --
The scientific unit for the actuator.
allowedValues (list) --
A list of possible values an actuator can take.
(string) --
min (float) --
The specified possible minimum value of an actuator.
max (float) --
The specified possible maximum value of an actuator.
assignedValue (string) --
A specified value for the actuator.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
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 .
attribute (dict) --
Information about a node specified as an attribute.
Note
An attribute represents static information about a vehicle.
fullyQualifiedName (string) --
The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type .
dataType (string) --
The specified data type of the attribute.
description (string) --
A brief description of the attribute.
unit (string) --
The scientific unit for the attribute.
allowedValues (list) --
A list of possible values an attribute can be assigned.
(string) --
min (float) --
The specified possible minimum value of the attribute.
max (float) --
The specified possible maximum value of the attribute.
assignedValue (string) --
A specified value for the attribute.
defaultValue (string) --
The default value of the attribute.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
struct (dict) --
Represents a complex or higher-order data structure.
fullyQualifiedName (string) --
The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be ComplexDataTypes.VehicleDataTypes.SVMCamera .
description (string) --
A brief description of the custom structure.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
property (dict) --
Represents a member of the complex data structure. The datatype of the property can be either primitive or another struct .
fullyQualifiedName (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 .
dataType (string) --
The data type for the custom property.
dataEncoding (string) --
Indicates whether the property is binary data.
description (string) --
A brief description of the custom property.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray .
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
{'networkInterfacesToAdd': {'type': {'CUSTOMER_DECODED_INTERFACE',
'VEHICLE_MIDDLEWARE'},
'vehicleMiddleware': {'name': 'string',
'protocolName': 'ROS_2'}},
'networkInterfacesToUpdate': {'type': {'CUSTOMER_DECODED_INTERFACE',
'VEHICLE_MIDDLEWARE'},
'vehicleMiddleware': {'name': 'string',
'protocolName': 'ROS_2'}},
'signalDecodersToAdd': {'messageSignal': {'structuredMessage': {'primitiveMessageDefinition': {'ros2PrimitiveMessageDefinition': {'offset': 'double',
'primitiveType': 'BOOL '
'| '
'BYTE '
'| '
'CHAR '
'| '
'FLOAT32 '
'| '
'FLOAT64 '
'| '
'INT8 '
'| '
'UINT8 '
'| '
'INT16 '
'| '
'UINT16 '
'| '
'INT32 '
'| '
'UINT32 '
'| '
'INT64 '
'| '
'UINT64 '
'| '
'STRING '
'| '
'WSTRING',
'scaling': 'double',
'upperBound': 'long'}},
'structuredMessageDefinition': [{'dataType': (),
'fieldName': 'string'}],
'structuredMessageListDefinition': {'capacity': 'integer',
'listType': 'FIXED_CAPACITY '
'| '
'DYNAMIC_UNBOUNDED_CAPACITY '
'| '
'DYNAMIC_BOUNDED_CAPACITY',
'memberType': (),
'name': 'string'}},
'topicName': 'string'},
'type': {'CUSTOMER_DECODED_SIGNAL', 'MESSAGE_SIGNAL'}},
'signalDecodersToUpdate': {'messageSignal': {'structuredMessage': {'primitiveMessageDefinition': {'ros2PrimitiveMessageDefinition': {'offset': 'double',
'primitiveType': 'BOOL '
'| '
'BYTE '
'| '
'CHAR '
'| '
'FLOAT32 '
'| '
'FLOAT64 '
'| '
'INT8 '
'| '
'UINT8 '
'| '
'INT16 '
'| '
'UINT16 '
'| '
'INT32 '
'| '
'UINT32 '
'| '
'INT64 '
'| '
'UINT64 '
'| '
'STRING '
'| '
'WSTRING',
'scaling': 'double',
'upperBound': 'long'}},
'structuredMessageDefinition': [{'dataType': (),
'fieldName': 'string'}],
'structuredMessageListDefinition': {'capacity': 'integer',
'listType': 'FIXED_CAPACITY '
'| '
'DYNAMIC_UNBOUNDED_CAPACITY '
'| '
'DYNAMIC_BOUNDED_CAPACITY',
'memberType': (),
'name': 'string'}},
'topicName': 'string'},
'type': {'CUSTOMER_DECODED_SIGNAL',
'MESSAGE_SIGNAL'}},
'status': {'INVALID', 'VALIDATING'}}
Updates a decoder manifest.
A decoder manifest can only be updated when the status is DRAFT . Only ACTIVE decoder manifests can be associated with vehicles.
See also: AWS API Documentation
Request Syntax
client.update_decoder_manifest(
name='string',
description='string',
signalDecodersToAdd=[
{
'fullyQualifiedName': 'string',
'type': 'CAN_SIGNAL'|'OBD_SIGNAL'|'MESSAGE_SIGNAL'|'CUSTOMER_DECODED_SIGNAL',
'interfaceId': 'string',
'canSignal': {
'messageId': 123,
'isBigEndian': True|False,
'isSigned': True|False,
'startBit': 123,
'offset': 123.0,
'factor': 123.0,
'length': 123,
'name': 'string'
},
'obdSignal': {
'pidResponseLength': 123,
'serviceMode': 123,
'pid': 123,
'scaling': 123.0,
'offset': 123.0,
'startByte': 123,
'byteLength': 123,
'bitRightShift': 123,
'bitMaskLength': 123
},
'messageSignal': {
'topicName': 'string',
'structuredMessage': {
'primitiveMessageDefinition': {
'ros2PrimitiveMessageDefinition': {
'primitiveType': 'BOOL'|'BYTE'|'CHAR'|'FLOAT32'|'FLOAT64'|'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'STRING'|'WSTRING',
'offset': 123.0,
'scaling': 123.0,
'upperBound': 123
}
},
'structuredMessageListDefinition': {
'name': 'string',
'memberType': {'... recursive ...'},
'listType': 'FIXED_CAPACITY'|'DYNAMIC_UNBOUNDED_CAPACITY'|'DYNAMIC_BOUNDED_CAPACITY',
'capacity': 123
},
'structuredMessageDefinition': [
{
'fieldName': 'string',
'dataType': {'... recursive ...'}
},
]
}
}
},
],
signalDecodersToUpdate=[
{
'fullyQualifiedName': 'string',
'type': 'CAN_SIGNAL'|'OBD_SIGNAL'|'MESSAGE_SIGNAL'|'CUSTOMER_DECODED_SIGNAL',
'interfaceId': 'string',
'canSignal': {
'messageId': 123,
'isBigEndian': True|False,
'isSigned': True|False,
'startBit': 123,
'offset': 123.0,
'factor': 123.0,
'length': 123,
'name': 'string'
},
'obdSignal': {
'pidResponseLength': 123,
'serviceMode': 123,
'pid': 123,
'scaling': 123.0,
'offset': 123.0,
'startByte': 123,
'byteLength': 123,
'bitRightShift': 123,
'bitMaskLength': 123
},
'messageSignal': {
'topicName': 'string',
'structuredMessage': {
'primitiveMessageDefinition': {
'ros2PrimitiveMessageDefinition': {
'primitiveType': 'BOOL'|'BYTE'|'CHAR'|'FLOAT32'|'FLOAT64'|'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'STRING'|'WSTRING',
'offset': 123.0,
'scaling': 123.0,
'upperBound': 123
}
},
'structuredMessageListDefinition': {
'name': 'string',
'memberType': {'... recursive ...'},
'listType': 'FIXED_CAPACITY'|'DYNAMIC_UNBOUNDED_CAPACITY'|'DYNAMIC_BOUNDED_CAPACITY',
'capacity': 123
},
'structuredMessageDefinition': [
{
'fieldName': 'string',
'dataType': {'... recursive ...'}
},
]
}
}
},
],
signalDecodersToRemove=[
'string',
],
networkInterfacesToAdd=[
{
'interfaceId': 'string',
'type': 'CAN_INTERFACE'|'OBD_INTERFACE'|'VEHICLE_MIDDLEWARE'|'CUSTOMER_DECODED_INTERFACE',
'canInterface': {
'name': 'string',
'protocolName': 'string',
'protocolVersion': 'string'
},
'obdInterface': {
'name': 'string',
'requestMessageId': 123,
'obdStandard': 'string',
'pidRequestIntervalSeconds': 123,
'dtcRequestIntervalSeconds': 123,
'useExtendedIds': True|False,
'hasTransmissionEcu': True|False
},
'vehicleMiddleware': {
'name': 'string',
'protocolName': 'ROS_2'
}
},
],
networkInterfacesToUpdate=[
{
'interfaceId': 'string',
'type': 'CAN_INTERFACE'|'OBD_INTERFACE'|'VEHICLE_MIDDLEWARE'|'CUSTOMER_DECODED_INTERFACE',
'canInterface': {
'name': 'string',
'protocolName': 'string',
'protocolVersion': 'string'
},
'obdInterface': {
'name': 'string',
'requestMessageId': 123,
'obdStandard': 'string',
'pidRequestIntervalSeconds': 123,
'dtcRequestIntervalSeconds': 123,
'useExtendedIds': True|False,
'hasTransmissionEcu': True|False
},
'vehicleMiddleware': {
'name': 'string',
'protocolName': 'ROS_2'
}
},
],
networkInterfacesToRemove=[
'string',
],
status='ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING'
)
string
[REQUIRED]
The name of the decoder manifest to update.
string
A brief description of the decoder manifest to update.
list
A list of information about decoding additional signals to add to the decoder manifest.
(dict) --
Information about a signal decoder.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of a signal decoder as defined in a vehicle model.
type (string) -- [REQUIRED]
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.
interfaceId (string) -- [REQUIRED]
The ID of a network interface that specifies what network protocol a vehicle follows.
canSignal (dict) --
Information about signal decoder using the Controller Area Network (CAN) protocol.
messageId (integer) -- [REQUIRED]
The ID of the message.
isBigEndian (boolean) -- [REQUIRED]
Whether the byte ordering of a CAN message is big-endian.
isSigned (boolean) -- [REQUIRED]
Whether the message data is specified as a signed value.
startBit (integer) -- [REQUIRED]
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 .
offset (float) -- [REQUIRED]
The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset .
factor (float) -- [REQUIRED]
A multiplier used to decode the CAN message.
length (integer) -- [REQUIRED]
How many bytes of data are in the message.
name (string) --
The name of the signal.
obdSignal (dict) --
Information about signal decoder using the On-board diagnostic (OBD) II protocol.
pidResponseLength (integer) -- [REQUIRED]
The length of the requested data.
serviceMode (integer) -- [REQUIRED]
The mode of operation (diagnostic service) in a message.
pid (integer) -- [REQUIRED]
The diagnostic code used to request data from a vehicle for this signal.
scaling (float) -- [REQUIRED]
A multiplier used to decode the message.
offset (float) -- [REQUIRED]
The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset .
startByte (integer) -- [REQUIRED]
Indicates the beginning of the message.
byteLength (integer) -- [REQUIRED]
The length of a message.
bitRightShift (integer) --
The number of positions to shift bits in the message.
bitMaskLength (integer) --
The number of bits to mask in a message.
messageSignal (dict) --
The decoding information for a specific message which supports higher order data types.
topicName (string) -- [REQUIRED]
The topic name for the message signal. It corresponds to topics in ROS 2.
structuredMessage (dict) -- [REQUIRED]
The structured message for the message signal. It can be defined with either a primitiveMessageDefinition , structuredMessageListDefinition , or structuredMessageDefinition recursively.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.
primitiveMessageDefinition (dict) --
Represents a primitive type node of the complex data structure.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ros2PrimitiveMessageDefinition.
ros2PrimitiveMessageDefinition (dict) --
Information about a PrimitiveMessage using a ROS 2 compliant primitive type message of the complex data structure.
primitiveType (string) -- [REQUIRED]
The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.
offset (float) --
The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset .
scaling (float) --
A multiplier used to decode the message.
upperBound (integer) --
An optional attribute specifying the upper bound for STRING and WSTRING .
structuredMessageListDefinition (dict) --
Represents a list type node of the complex data structure.
name (string) -- [REQUIRED]
The name of the structured message list definition.
memberType (dict) --
The member type of the structured message list definition.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.
listType (string) -- [REQUIRED]
The type of list of the structured message list definition.
capacity (integer) --
The capacity of the structured message list definition when the list type is FIXED_CAPACITY or DYNAMIC_BOUNDED_CAPACITY .
structuredMessageDefinition (list) --
Represents a struct type node of the complex data structure.
(dict) --
Represents a StructureMessageName to DataType map element.
fieldName (string) -- [REQUIRED]
The field name of the structured message. It determines how a data value is referenced in the target language.
dataType (dict) --
The data type.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.
list
A list of updated information about decoding signals to update in the decoder manifest.
(dict) --
Information about a signal decoder.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of a signal decoder as defined in a vehicle model.
type (string) -- [REQUIRED]
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.
interfaceId (string) -- [REQUIRED]
The ID of a network interface that specifies what network protocol a vehicle follows.
canSignal (dict) --
Information about signal decoder using the Controller Area Network (CAN) protocol.
messageId (integer) -- [REQUIRED]
The ID of the message.
isBigEndian (boolean) -- [REQUIRED]
Whether the byte ordering of a CAN message is big-endian.
isSigned (boolean) -- [REQUIRED]
Whether the message data is specified as a signed value.
startBit (integer) -- [REQUIRED]
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 .
offset (float) -- [REQUIRED]
The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset .
factor (float) -- [REQUIRED]
A multiplier used to decode the CAN message.
length (integer) -- [REQUIRED]
How many bytes of data are in the message.
name (string) --
The name of the signal.
obdSignal (dict) --
Information about signal decoder using the On-board diagnostic (OBD) II protocol.
pidResponseLength (integer) -- [REQUIRED]
The length of the requested data.
serviceMode (integer) -- [REQUIRED]
The mode of operation (diagnostic service) in a message.
pid (integer) -- [REQUIRED]
The diagnostic code used to request data from a vehicle for this signal.
scaling (float) -- [REQUIRED]
A multiplier used to decode the message.
offset (float) -- [REQUIRED]
The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset .
startByte (integer) -- [REQUIRED]
Indicates the beginning of the message.
byteLength (integer) -- [REQUIRED]
The length of a message.
bitRightShift (integer) --
The number of positions to shift bits in the message.
bitMaskLength (integer) --
The number of bits to mask in a message.
messageSignal (dict) --
The decoding information for a specific message which supports higher order data types.
topicName (string) -- [REQUIRED]
The topic name for the message signal. It corresponds to topics in ROS 2.
structuredMessage (dict) -- [REQUIRED]
The structured message for the message signal. It can be defined with either a primitiveMessageDefinition , structuredMessageListDefinition , or structuredMessageDefinition recursively.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.
primitiveMessageDefinition (dict) --
Represents a primitive type node of the complex data structure.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ros2PrimitiveMessageDefinition.
ros2PrimitiveMessageDefinition (dict) --
Information about a PrimitiveMessage using a ROS 2 compliant primitive type message of the complex data structure.
primitiveType (string) -- [REQUIRED]
The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.
offset (float) --
The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset .
scaling (float) --
A multiplier used to decode the message.
upperBound (integer) --
An optional attribute specifying the upper bound for STRING and WSTRING .
structuredMessageListDefinition (dict) --
Represents a list type node of the complex data structure.
name (string) -- [REQUIRED]
The name of the structured message list definition.
memberType (dict) --
The member type of the structured message list definition.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.
listType (string) -- [REQUIRED]
The type of list of the structured message list definition.
capacity (integer) --
The capacity of the structured message list definition when the list type is FIXED_CAPACITY or DYNAMIC_BOUNDED_CAPACITY .
structuredMessageDefinition (list) --
Represents a struct type node of the complex data structure.
(dict) --
Represents a StructureMessageName to DataType map element.
fieldName (string) -- [REQUIRED]
The field name of the structured message. It determines how a data value is referenced in the target language.
dataType (dict) --
The data type.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.
list
A list of signal decoders to remove from the decoder manifest.
(string) --
list
A list of information about the network interfaces to add to the decoder manifest.
(dict) --
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.
interfaceId (string) -- [REQUIRED]
The ID of the network interface.
type (string) -- [REQUIRED]
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 (dict) --
Information about a network interface specified by the Controller Area Network (CAN) protocol.
name (string) -- [REQUIRED]
The unique name of the interface.
protocolName (string) --
The name of the communication protocol for the interface.
protocolVersion (string) --
The version of the communication protocol for the interface.
obdInterface (dict) --
Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
name (string) -- [REQUIRED]
The name of the interface.
requestMessageId (integer) -- [REQUIRED]
The ID of the message requesting vehicle data.
obdStandard (string) --
The standard OBD II PID.
pidRequestIntervalSeconds (integer) --
The maximum number message requests per second.
dtcRequestIntervalSeconds (integer) --
The maximum number message requests per diagnostic trouble code per second.
useExtendedIds (boolean) --
Whether to use extended IDs in the message.
hasTransmissionEcu (boolean) --
Whether the vehicle has a transmission control module (TCM).
vehicleMiddleware (dict) --
The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP .
name (string) -- [REQUIRED]
The name of the vehicle middleware.
protocolName (string) -- [REQUIRED]
The protocol name of the vehicle middleware.
list
A list of information about the network interfaces to update in the decoder manifest.
(dict) --
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.
interfaceId (string) -- [REQUIRED]
The ID of the network interface.
type (string) -- [REQUIRED]
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 (dict) --
Information about a network interface specified by the Controller Area Network (CAN) protocol.
name (string) -- [REQUIRED]
The unique name of the interface.
protocolName (string) --
The name of the communication protocol for the interface.
protocolVersion (string) --
The version of the communication protocol for the interface.
obdInterface (dict) --
Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
name (string) -- [REQUIRED]
The name of the interface.
requestMessageId (integer) -- [REQUIRED]
The ID of the message requesting vehicle data.
obdStandard (string) --
The standard OBD II PID.
pidRequestIntervalSeconds (integer) --
The maximum number message requests per second.
dtcRequestIntervalSeconds (integer) --
The maximum number message requests per diagnostic trouble code per second.
useExtendedIds (boolean) --
Whether to use extended IDs in the message.
hasTransmissionEcu (boolean) --
Whether the vehicle has a transmission control module (TCM).
vehicleMiddleware (dict) --
The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP .
name (string) -- [REQUIRED]
The name of the vehicle middleware.
protocolName (string) -- [REQUIRED]
The protocol name of the vehicle middleware.
list
A list of network interfaces to remove from the decoder manifest.
(string) --
string
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.
dict
Response Syntax
{
'name': 'string',
'arn': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the updated decoder manifest.
arn (string) --
The Amazon Resource Name (ARN) of the updated decoder manifest.
{'status': {'INVALID', 'VALIDATING'}}
Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.
See also: AWS API Documentation
Request Syntax
client.update_model_manifest(
name='string',
description='string',
nodesToAdd=[
'string',
],
nodesToRemove=[
'string',
],
status='ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING'
)
string
[REQUIRED]
The name of the vehicle model to update.
string
A brief description of the vehicle model.
list
A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to add to the vehicle model.
(string) --
list
A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to remove from the vehicle model.
(string) --
string
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.
dict
Response Syntax
{
'name': 'string',
'arn': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the updated vehicle model.
arn (string) --
The Amazon Resource Name (ARN) of the updated vehicle model.
{'nodesToAdd': {'actuator': {'dataType': {'STRUCT_ARRAY', 'STRUCT'},
'structFullyQualifiedName': 'string'},
'attribute': {'dataType': {'STRUCT_ARRAY', 'STRUCT'}},
'property': {'comment': 'string',
'dataEncoding': 'BINARY | TYPED',
'dataType': 'INT8 | UINT8 | INT16 | UINT16 | '
'INT32 | UINT32 | INT64 | UINT64 | '
'BOOLEAN | FLOAT | DOUBLE | STRING | '
'UNIX_TIMESTAMP | INT8_ARRAY | '
'UINT8_ARRAY | INT16_ARRAY | '
'UINT16_ARRAY | INT32_ARRAY | '
'UINT32_ARRAY | INT64_ARRAY | '
'UINT64_ARRAY | BOOLEAN_ARRAY | '
'FLOAT_ARRAY | DOUBLE_ARRAY | '
'STRING_ARRAY | UNIX_TIMESTAMP_ARRAY '
'| UNKNOWN | STRUCT | STRUCT_ARRAY',
'deprecationMessage': 'string',
'description': 'string',
'fullyQualifiedName': 'string',
'structFullyQualifiedName': 'string'},
'sensor': {'dataType': {'STRUCT_ARRAY', 'STRUCT'},
'structFullyQualifiedName': 'string'},
'struct': {'comment': 'string',
'deprecationMessage': 'string',
'description': 'string',
'fullyQualifiedName': 'string'}},
'nodesToUpdate': {'actuator': {'dataType': {'STRUCT_ARRAY', 'STRUCT'},
'structFullyQualifiedName': 'string'},
'attribute': {'dataType': {'STRUCT_ARRAY', 'STRUCT'}},
'property': {'comment': 'string',
'dataEncoding': 'BINARY | TYPED',
'dataType': 'INT8 | UINT8 | INT16 | UINT16 | '
'INT32 | UINT32 | INT64 | UINT64 | '
'BOOLEAN | FLOAT | DOUBLE | STRING '
'| UNIX_TIMESTAMP | INT8_ARRAY | '
'UINT8_ARRAY | INT16_ARRAY | '
'UINT16_ARRAY | INT32_ARRAY | '
'UINT32_ARRAY | INT64_ARRAY | '
'UINT64_ARRAY | BOOLEAN_ARRAY | '
'FLOAT_ARRAY | DOUBLE_ARRAY | '
'STRING_ARRAY | '
'UNIX_TIMESTAMP_ARRAY | UNKNOWN | '
'STRUCT | STRUCT_ARRAY',
'deprecationMessage': 'string',
'description': 'string',
'fullyQualifiedName': 'string',
'structFullyQualifiedName': 'string'},
'sensor': {'dataType': {'STRUCT_ARRAY', 'STRUCT'},
'structFullyQualifiedName': 'string'},
'struct': {'comment': 'string',
'deprecationMessage': 'string',
'description': 'string',
'fullyQualifiedName': 'string'}}}
Updates a signal catalog.
See also: AWS API Documentation
Request Syntax
client.update_signal_catalog(
name='string',
description='string',
nodesToAdd=[
{
'branch': {
'fullyQualifiedName': 'string',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'sensor': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
},
'actuator': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'assignedValue': 'string',
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
},
'attribute': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'assignedValue': 'string',
'defaultValue': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'struct': {
'fullyQualifiedName': 'string',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'property': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'dataEncoding': 'BINARY'|'TYPED',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
}
},
],
nodesToUpdate=[
{
'branch': {
'fullyQualifiedName': 'string',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'sensor': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
},
'actuator': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'assignedValue': 'string',
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
},
'attribute': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'description': 'string',
'unit': 'string',
'allowedValues': [
'string',
],
'min': 123.0,
'max': 123.0,
'assignedValue': 'string',
'defaultValue': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'struct': {
'fullyQualifiedName': 'string',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string'
},
'property': {
'fullyQualifiedName': 'string',
'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY',
'dataEncoding': 'BINARY'|'TYPED',
'description': 'string',
'deprecationMessage': 'string',
'comment': 'string',
'structFullyQualifiedName': 'string'
}
},
],
nodesToRemove=[
'string',
]
)
string
[REQUIRED]
The name of the signal catalog to update.
string
A brief description of the signal catalog to update.
list
A list of information about nodes to add to the signal catalog.
(dict) --
A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: branch, sensor, actuator, attribute, struct, property.
branch (dict) --
Information about a node specified as a branch.
Note
A group of signals that are defined in a hierarchical structure.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the branch. For example, the fully qualified name of a branch might be Vehicle.Body.Engine .
description (string) --
A brief description of the branch.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
sensor (dict) --
An input component that reports the environmental condition of a vehicle.
Note
You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery .
dataType (string) -- [REQUIRED]
The specified data type of the sensor.
description (string) --
A brief description of a sensor.
unit (string) --
The scientific unit of measurement for data collected by the sensor.
allowedValues (list) --
A list of possible values a sensor can take.
(string) --
min (float) --
The specified possible minimum value of the sensor.
max (float) --
The specified possible maximum value of the sensor.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
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 .
actuator (dict) --
Information about a node specified as an actuator.
Note
An actuator is a digital representation of a vehicle device.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock .
dataType (string) -- [REQUIRED]
The specified data type of the actuator.
description (string) --
A brief description of the actuator.
unit (string) --
The scientific unit for the actuator.
allowedValues (list) --
A list of possible values an actuator can take.
(string) --
min (float) --
The specified possible minimum value of an actuator.
max (float) --
The specified possible maximum value of an actuator.
assignedValue (string) --
A specified value for the actuator.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
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 .
attribute (dict) --
Information about a node specified as an attribute.
Note
An attribute represents static information about a vehicle.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type .
dataType (string) -- [REQUIRED]
The specified data type of the attribute.
description (string) --
A brief description of the attribute.
unit (string) --
The scientific unit for the attribute.
allowedValues (list) --
A list of possible values an attribute can be assigned.
(string) --
min (float) --
The specified possible minimum value of the attribute.
max (float) --
The specified possible maximum value of the attribute.
assignedValue (string) --
A specified value for the attribute.
defaultValue (string) --
The default value of the attribute.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
struct (dict) --
Represents a complex or higher-order data structure.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be ComplexDataTypes.VehicleDataTypes.SVMCamera .
description (string) --
A brief description of the custom structure.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
property (dict) --
Represents a member of the complex data structure. The datatype of the property can be either primitive or another struct .
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS .
dataType (string) -- [REQUIRED]
The data type for the custom property.
dataEncoding (string) --
Indicates whether the property is binary data.
description (string) --
A brief description of the custom property.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray .
list
A list of information about nodes to update in the signal catalog.
(dict) --
A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: branch, sensor, actuator, attribute, struct, property.
branch (dict) --
Information about a node specified as a branch.
Note
A group of signals that are defined in a hierarchical structure.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the branch. For example, the fully qualified name of a branch might be Vehicle.Body.Engine .
description (string) --
A brief description of the branch.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
sensor (dict) --
An input component that reports the environmental condition of a vehicle.
Note
You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery .
dataType (string) -- [REQUIRED]
The specified data type of the sensor.
description (string) --
A brief description of a sensor.
unit (string) --
The scientific unit of measurement for data collected by the sensor.
allowedValues (list) --
A list of possible values a sensor can take.
(string) --
min (float) --
The specified possible minimum value of the sensor.
max (float) --
The specified possible maximum value of the sensor.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
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 .
actuator (dict) --
Information about a node specified as an actuator.
Note
An actuator is a digital representation of a vehicle device.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock .
dataType (string) -- [REQUIRED]
The specified data type of the actuator.
description (string) --
A brief description of the actuator.
unit (string) --
The scientific unit for the actuator.
allowedValues (list) --
A list of possible values an actuator can take.
(string) --
min (float) --
The specified possible minimum value of an actuator.
max (float) --
The specified possible maximum value of an actuator.
assignedValue (string) --
A specified value for the actuator.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
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 .
attribute (dict) --
Information about a node specified as an attribute.
Note
An attribute represents static information about a vehicle.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type .
dataType (string) -- [REQUIRED]
The specified data type of the attribute.
description (string) --
A brief description of the attribute.
unit (string) --
The scientific unit for the attribute.
allowedValues (list) --
A list of possible values an attribute can be assigned.
(string) --
min (float) --
The specified possible minimum value of the attribute.
max (float) --
The specified possible maximum value of the attribute.
assignedValue (string) --
A specified value for the attribute.
defaultValue (string) --
The default value of the attribute.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
struct (dict) --
Represents a complex or higher-order data structure.
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be ComplexDataTypes.VehicleDataTypes.SVMCamera .
description (string) --
A brief description of the custom structure.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
property (dict) --
Represents a member of the complex data structure. The datatype of the property can be either primitive or another struct .
fullyQualifiedName (string) -- [REQUIRED]
The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS .
dataType (string) -- [REQUIRED]
The data type for the custom property.
dataEncoding (string) --
Indicates whether the property is binary data.
description (string) --
A brief description of the custom property.
deprecationMessage (string) --
The deprecation message for the node or the branch that was moved or deleted.
comment (string) --
A comment in addition to the description.
structFullyQualifiedName (string) --
The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray .
list
A list of fullyQualifiedName of nodes to remove from the signal catalog.
(string) --
dict
Response Syntax
{
'name': 'string',
'arn': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the updated signal catalog.
arn (string) --
The ARN of the updated signal catalog.