IoTFleetWise / Paginator / ListModelManifestNodes
ListModelManifestNodes#
- class IoTFleetWise.Paginator.ListModelManifestNodes#
paginator = client.get_paginator('list_model_manifest_nodes')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
IoTFleetWise.Client.list_model_manifest_nodes()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( name='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
name (string) –
[REQUIRED]
The name of the vehicle model to list information about.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
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', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'deprecationMessage': 'string', 'comment': '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', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'deprecationMessage': 'string', 'comment': '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', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'defaultValue': 'string', 'deprecationMessage': 'string', 'comment': '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
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_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.
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.
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.
NextToken (string) –
A token to resume pagination.