IoTFleetWise / Client / create_signal_catalog

create_signal_catalog#

IoTFleetWise.Client.create_signal_catalog(**kwargs)#

Creates a collection of standardized signals that can be reused to create vehicle models.

Request Syntax

response = 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'
        },
    ]
)

Parameters:

name (string) –
[REQUIRED]

The name of the signal catalog to create.
description (string) – A brief description of the signal catalog.
nodes (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.
tags (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.

Return type:

dict

Returns:

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.

create_signal_catalog#

Request Syntax

Note

Note

Note

Note

Note

Response Syntax

Response Structure

Exceptions