2023/05/30 - AWS IoT FleetWise - 6 updated api methods
Changes Campaigns now support selecting Timestream or S3 as the data destination, Signal catalogs now support "Deprecation" keyword released in VSS v2.1 and "Comment" keyword released in VSS v3.0
{'dataDestinationConfigs': [{'s3Config': {'bucketArn': 'string',
'dataFormat': 'JSON | PARQUET',
'prefix': 'string',
'storageCompressionFormat': 'NONE | '
'GZIP'},
'timestreamConfig': {'executionRoleArn': 'string',
'timestreamTableArn': 'string'}}]}
Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles.
For more information, see Collect and transfer data with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.
See also: AWS API Documentation
Request Syntax
client.create_campaign(
name='string',
description='string',
signalCatalogArn='string',
targetArn='string',
startTime=datetime(2015, 1, 1),
expiryTime=datetime(2015, 1, 1),
postTriggerCollectionDuration=123,
diagnosticsMode='OFF'|'SEND_ACTIVE_DTCS',
spoolingMode='OFF'|'TO_DISK',
compression='OFF'|'SNAPPY',
priority=123,
signalsToCollect=[
{
'name': 'string',
'maxSampleCount': 123,
'minimumSamplingIntervalMs': 123
},
],
collectionScheme={
'timeBasedCollectionScheme': {
'periodMs': 123
},
'conditionBasedCollectionScheme': {
'expression': 'string',
'minimumTriggerIntervalMs': 123,
'triggerMode': 'ALWAYS'|'RISING_EDGE',
'conditionLanguageVersion': 123
}
},
dataExtraDimensions=[
'string',
],
tags=[
{
'Key': 'string',
'Value': 'string'
},
],
dataDestinationConfigs=[
{
's3Config': {
'bucketArn': 'string',
'dataFormat': 'JSON'|'PARQUET',
'storageCompressionFormat': 'NONE'|'GZIP',
'prefix': 'string'
},
'timestreamConfig': {
'timestreamTableArn': 'string',
'executionRoleArn': 'string'
}
},
]
)
string
[REQUIRED]
The name of the campaign to create.
string
An optional description of the campaign to help identify its purpose.
string
[REQUIRED]
(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
string
[REQUIRED]
The ARN of the vehicle or fleet to deploy a campaign to.
datetime
(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.
Default: 0
datetime
(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires.
Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
integer
(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0 is used.
Default: 0
string
(Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS. If it's not specified, OFF is used.
Default: OFF
string
(Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used.
Default: OFF
string
(Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If it's not specified, SNAPPY is used.
Default: SNAPPY
integer
(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used.
Default: 0
list
(Optional) A list of information about signals to collect.
(dict) --
Information about a signal.
name (string) -- [REQUIRED]
The name of the signal.
maxSampleCount (integer) --
The maximum number of samples to collect.
minimumSamplingIntervalMs (integer) --
The minimum duration of time (in milliseconds) between two triggering events to collect data.
dict
[REQUIRED]
The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.
timeBasedCollectionScheme (dict) --
Information about a collection scheme that uses a time period to decide how often to collect data.
periodMs (integer) -- [REQUIRED]
The time period (in milliseconds) to decide how often to collect data. For example, if the time period is 60000, the Edge Agent software collects data once every minute.
conditionBasedCollectionScheme (dict) --
Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
expression (string) -- [REQUIRED]
The logical expression used to recognize what data to collect. For example, $variable.Vehicle.OutsideAirTemperature >= 105.0.
minimumTriggerIntervalMs (integer) --
The minimum duration of time between two triggering events to collect data, in milliseconds.
triggerMode (string) --
Whether to collect data for all triggering events ( ALWAYS). Specify ( RISING_EDGE), or specify only when the condition first evaluates to false. For example, triggering on "AirbagDeployed"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.
conditionLanguageVersion (integer) --
Specifies the version of the conditional expression language.
list
(Optional) A list of vehicle attributes to associate with a campaign.
Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model.
Default: An empty array
(string) --
list
Metadata that can be used to manage the campaign.
(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.
list
The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
(dict) --
The destination where the Amazon Web Services IoT FleetWise campaign sends data. You can send data to be stored in Amazon S3 or Amazon Timestream.
s3Config (dict) --
The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.
bucketArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon S3 bucket.
dataFormat (string) --
Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.
Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
JSON - Store data in a standard text-based JSON file format.
storageCompressionFormat (string) --
By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
prefix (string) --
(Optional) Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
By default, Amazon Web Services IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles, the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.
timestreamConfig (dict) --
The Amazon Timestream table where the campaign sends data.
timestreamTableArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Timestream table.
executionRoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the task execution role that grants Amazon Web Services IoT FleetWise permission to deliver data to the Amazon Timestream table.
dict
Response Syntax
{
'name': 'string',
'arn': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the created campaign.
arn (string) --
The ARN of the created campaign.
{'nodes': {'actuator': {'comment': 'string', 'deprecationMessage': 'string'},
'attribute': {'comment': 'string', 'deprecationMessage': 'string'},
'branch': {'comment': 'string', 'deprecationMessage': 'string'},
'sensor': {'comment': 'string', 'deprecationMessage': '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',
'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'
}
},
],
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.
branch (dict) --
Information about a node specified as a branch.
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.
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.
actuator (dict) --
Information about a node specified as an actuator.
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.
attribute (dict) --
Information about a node specified as an attribute.
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.
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.
{'dataDestinationConfigs': [{'s3Config': {'bucketArn': 'string',
'dataFormat': 'JSON | PARQUET',
'prefix': 'string',
'storageCompressionFormat': 'NONE | '
'GZIP'},
'timestreamConfig': {'executionRoleArn': 'string',
'timestreamTableArn': 'string'}}]}
Retrieves information about a campaign.
See also: AWS API Documentation
Request Syntax
client.get_campaign(
name='string'
)
string
[REQUIRED]
The name of the campaign to retrieve information about.
dict
Response Syntax
{
'name': 'string',
'arn': 'string',
'description': 'string',
'signalCatalogArn': 'string',
'targetArn': 'string',
'status': 'CREATING'|'WAITING_FOR_APPROVAL'|'RUNNING'|'SUSPENDED',
'startTime': datetime(2015, 1, 1),
'expiryTime': datetime(2015, 1, 1),
'postTriggerCollectionDuration': 123,
'diagnosticsMode': 'OFF'|'SEND_ACTIVE_DTCS',
'spoolingMode': 'OFF'|'TO_DISK',
'compression': 'OFF'|'SNAPPY',
'priority': 123,
'signalsToCollect': [
{
'name': 'string',
'maxSampleCount': 123,
'minimumSamplingIntervalMs': 123
},
],
'collectionScheme': {
'timeBasedCollectionScheme': {
'periodMs': 123
},
'conditionBasedCollectionScheme': {
'expression': 'string',
'minimumTriggerIntervalMs': 123,
'triggerMode': 'ALWAYS'|'RISING_EDGE',
'conditionLanguageVersion': 123
}
},
'dataExtraDimensions': [
'string',
],
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1),
'dataDestinationConfigs': [
{
's3Config': {
'bucketArn': 'string',
'dataFormat': 'JSON'|'PARQUET',
'storageCompressionFormat': 'NONE'|'GZIP',
'prefix': 'string'
},
'timestreamConfig': {
'timestreamTableArn': 'string',
'executionRoleArn': 'string'
}
},
]
}
Response Structure
(dict) --
name (string) --
The name of the campaign.
arn (string) --
The Amazon Resource Name (ARN) of the campaign.
description (string) --
The description of the campaign.
signalCatalogArn (string) --
The ARN of a signal catalog.
targetArn (string) --
The ARN of the vehicle or the fleet targeted by the campaign.
status (string) --
The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.
startTime (datetime) --
The time, in milliseconds, to deliver a campaign after it was approved.
expiryTime (datetime) --
The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.
postTriggerCollectionDuration (integer) --
How long (in seconds) to collect raw data after a triggering event initiates the collection.
diagnosticsMode (string) --
Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
spoolingMode (string) --
Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.
compression (string) --
Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.
priority (integer) --
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.
signalsToCollect (list) --
Information about a list of signals to collect data on.
(dict) --
Information about a signal.
name (string) --
The name of the signal.
maxSampleCount (integer) --
The maximum number of samples to collect.
minimumSamplingIntervalMs (integer) --
The minimum duration of time (in milliseconds) between two triggering events to collect data.
collectionScheme (dict) --
Information about the data collection scheme associated with the campaign.
timeBasedCollectionScheme (dict) --
Information about a collection scheme that uses a time period to decide how often to collect data.
periodMs (integer) --
The time period (in milliseconds) to decide how often to collect data. For example, if the time period is 60000, the Edge Agent software collects data once every minute.
conditionBasedCollectionScheme (dict) --
Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
expression (string) --
The logical expression used to recognize what data to collect. For example, $variable.Vehicle.OutsideAirTemperature >= 105.0.
minimumTriggerIntervalMs (integer) --
The minimum duration of time between two triggering events to collect data, in milliseconds.
triggerMode (string) --
Whether to collect data for all triggering events ( ALWAYS). Specify ( RISING_EDGE), or specify only when the condition first evaluates to false. For example, triggering on "AirbagDeployed"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.
conditionLanguageVersion (integer) --
Specifies the version of the conditional expression language.
dataExtraDimensions (list) --
A list of vehicle attributes associated with the campaign.
(string) --
creationTime (datetime) --
The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
lastModificationTime (datetime) --
The last time the campaign was modified.
dataDestinationConfigs (list) --
The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
(dict) --
The destination where the Amazon Web Services IoT FleetWise campaign sends data. You can send data to be stored in Amazon S3 or Amazon Timestream.
s3Config (dict) --
The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.
bucketArn (string) --
The Amazon Resource Name (ARN) of the Amazon S3 bucket.
dataFormat (string) --
Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.
Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
JSON - Store data in a standard text-based JSON file format.
storageCompressionFormat (string) --
By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
prefix (string) --
(Optional) Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
By default, Amazon Web Services IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles, the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.
timestreamConfig (dict) --
The Amazon Timestream table where the campaign sends data.
timestreamTableArn (string) --
The Amazon Resource Name (ARN) of the Amazon Timestream table.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the task execution role that grants Amazon Web Services IoT FleetWise permission to deliver data to the Amazon Timestream table.
{'nodes': {'actuator': {'comment': 'string', 'deprecationMessage': 'string'},
'attribute': {'comment': 'string', 'deprecationMessage': 'string'},
'branch': {'comment': 'string', 'deprecationMessage': 'string'},
'sensor': {'comment': 'string', 'deprecationMessage': 'string'}}}
Lists information about nodes specified in a vehicle model (model manifest).
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',
'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.
branch (dict) --
Information about a node specified as a branch.
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.
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.
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.
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) --
The token to retrieve the next set of results, or null if there are no more results.
{'nodes': {'actuator': {'comment': 'string', 'deprecationMessage': 'string'},
'attribute': {'comment': 'string', 'deprecationMessage': 'string'},
'branch': {'comment': 'string', 'deprecationMessage': 'string'},
'sensor': {'comment': 'string', 'deprecationMessage': 'string'}}}
Lists of information about the signals (nodes) specified in a signal catalog.
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',
'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.
branch (dict) --
Information about a node specified as a branch.
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.
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.
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.
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) --
The token to retrieve the next set of results, or null if there are no more results.
{'nodesToAdd': {'actuator': {'comment': 'string',
'deprecationMessage': 'string'},
'attribute': {'comment': 'string',
'deprecationMessage': 'string'},
'branch': {'comment': 'string', 'deprecationMessage': 'string'},
'sensor': {'comment': 'string',
'deprecationMessage': 'string'}},
'nodesToUpdate': {'actuator': {'comment': 'string',
'deprecationMessage': 'string'},
'attribute': {'comment': 'string',
'deprecationMessage': 'string'},
'branch': {'comment': 'string',
'deprecationMessage': 'string'},
'sensor': {'comment': 'string',
'deprecationMessage': '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',
'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'
}
},
],
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',
'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'
}
},
],
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.
branch (dict) --
Information about a node specified as a branch.
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.
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.
actuator (dict) --
Information about a node specified as an actuator.
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.
attribute (dict) --
Information about a node specified as an attribute.
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.
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.
branch (dict) --
Information about a node specified as a branch.
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.
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.
actuator (dict) --
Information about a node specified as an actuator.
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.
attribute (dict) --
Information about a node specified as an attribute.
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.
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.