2022/09/26 - AWS IoT FleetWise - 50 new api methods
Changes General availability (GA) for AWS IoT Fleetwise. It adds AWS IoT Fleetwise to AWS SDK. For more information, see https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/Welcome.html.
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)
}
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.
Note
If a signal changes often, you might want to collect data at a slower rate.
collectionScheme (dict) --
Information about the data collection scheme associated with the campaign.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: timeBasedCollectionScheme, conditionBasedCollectionScheme. 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'}
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.
Note
If a signal changes often, you might want to collect data at a slower rate.
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.
Retrieves information about a vehicle.
See also: AWS API Documentation
Request Syntax
client.get_vehicle(
vehicleName='string'
)
string
[REQUIRED]
The ID of the vehicle to retrieve information about.
dict
Response Syntax
{
'vehicleName': 'string',
'arn': 'string',
'modelManifestArn': 'string',
'decoderManifestArn': 'string',
'attributes': {
'string': 'string'
},
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
vehicleName (string) --
The ID of the vehicle.
arn (string) --
The Amazon Resource Name (ARN) of the vehicle to retrieve information about.
modelManifestArn (string) --
The ARN of a vehicle model (model manifest) associated with the vehicle.
decoderManifestArn (string) --
The ARN of a decoder manifest associated with the vehicle.
attributes (dict) --
Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
(string) --
(string) --
creationTime (datetime) --
The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
lastModificationTime (datetime) --
The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
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'
},
'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
},
'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'
},
'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'
}
},
],
nodesToUpdate=[
{
'branch': {
'fullyQualifiedName': 'string',
'description': '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
},
'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'
},
'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'
}
},
],
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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',
'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.
Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).
For more information, see Vehicle models in the Amazon Web Services IoT FleetWise Developer Guide .
See also: AWS API Documentation
Request Syntax
client.create_model_manifest(
name='string',
description='string',
nodes=[
'string',
],
signalCatalogArn='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the vehicle model to create.
string
A brief description of the vehicle model.
list
[REQUIRED]
A list of nodes, which are a general abstraction of signals.
(string) --
string
[REQUIRED]
The Amazon Resource Name (ARN) of a signal catalog.
list
Metadata that can be used to manage the vehicle model.
(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 vehicle model.
arn (string) --
The ARN of the created vehicle model.
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'
},
'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
},
'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'
},
'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'
}
},
],
'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 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.
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.
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.
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.
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
Updates a vehicle.
See also: AWS API Documentation
Request Syntax
client.update_vehicle(
vehicleName='string',
modelManifestArn='string',
decoderManifestArn='string',
attributes={
'string': 'string'
},
attributeUpdateMode='Overwrite'|'Merge'
)
string
[REQUIRED]
The unique ID of the vehicle to update.
string
The ARN of a vehicle model (model manifest) associated with the vehicle.
string
The ARN of the decoder manifest associated with this vehicle.
dict
Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
(string) --
(string) --
string
The method the specified attributes will update the existing attributes on the vehicle. Use Overwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.
This is required if attributes are present in the input.
dict
Response Syntax
{
'vehicleName': 'string',
'arn': 'string'
}
Response Structure
(dict) --
vehicleName (string) --
The ID of the updated vehicle.
arn (string) --
The ARN of the updated vehicle.
Adds, or associates, a vehicle with a fleet.
See also: AWS API Documentation
Request Syntax
client.associate_vehicle_fleet(
vehicleName='string',
fleetId='string'
)
string
[REQUIRED]
The unique ID of the vehicle to associate with the fleet.
string
[REQUIRED]
The ID of a fleet.
dict
Response Syntax
{}
Response Structure
(dict) --
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',
'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
}
},
],
'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 message.
offset (float) --
Indicates where data appears in the CAN message.
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) --
Indicates where data appears in the message.
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.
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.
Note
If you have an existing Amazon Web Services IoT Thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing.
For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide .
See also: AWS API Documentation
Request Syntax
client.create_vehicle(
vehicleName='string',
modelManifestArn='string',
decoderManifestArn='string',
attributes={
'string': 'string'
},
associationBehavior='CreateIotThing'|'ValidateIotThingExists',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The unique ID of the vehicle to create.
string
[REQUIRED]
The Amazon Resource Name ARN of a vehicle model.
string
[REQUIRED]
The ARN of a decoder manifest.
dict
Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"
(string) --
(string) --
string
An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.
Default:
list
Metadata that can be used to manage the vehicle.
(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
{
'vehicleName': 'string',
'arn': 'string',
'thingArn': 'string'
}
Response Structure
(dict) --
vehicleName (string) --
The unique ID of the created vehicle.
arn (string) --
The ARN of the created vehicle.
thingArn (string) --
The ARN of a created or validated Amazon Web Services IoT thing.
Removes the given tags (metadata) from the resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the resource.
list
[REQUIRED]
A list of the keys of the tags to be removed from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Lists information about created campaigns.
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_campaigns(
nextToken='string',
maxResults=123,
status='string'
)
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.
string
Optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING , WAITING_FOR_APPROVAL , RUNNING , or SUSPENDED .
dict
Response Syntax
{
'campaignSummaries': [
{
'arn': 'string',
'name': 'string',
'description': 'string',
'signalCatalogArn': 'string',
'targetArn': 'string',
'status': 'CREATING'|'WAITING_FOR_APPROVAL'|'RUNNING'|'SUSPENDED',
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
campaignSummaries (list) --
A summary of information about each campaign.
(dict) --
Information about a campaign.
You can use the API operation to return this information about multiple created campaigns.
arn (string) --
The Amazon Resource Name (ARN) of a campaign.
name (string) --
The name of a campaign.
description (string) --
The description of the campaign.
signalCatalogArn (string) --
The ARN of the signal catalog associated with the campaign.
targetArn (string) --
The ARN of a vehicle or fleet to which the campaign is deployed.
status (string) --
The state of a campaign. The status can be one of the following:
CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.
WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.
RUNNING - The campaign is active.
SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.
creationTime (datetime) --
The time the campaign was created.
lastModificationTime (datetime) --
The last time the campaign was modified.
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
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',
'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
}
},
],
signalDecodersToUpdate=[
{
'fullyQualifiedName': 'string',
'type': 'CAN_SIGNAL'|'OBD_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
}
},
],
signalDecodersToRemove=[
'string',
],
networkInterfacesToAdd=[
{
'interfaceId': 'string',
'type': 'CAN_INTERFACE'|'OBD_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
}
},
],
networkInterfacesToUpdate=[
{
'interfaceId': 'string',
'type': 'CAN_INTERFACE'|'OBD_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
}
},
],
networkInterfacesToRemove=[
'string',
],
status='ACTIVE'|'DRAFT'
)
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 message.
offset (float) -- [REQUIRED]
Indicates where data appears in the CAN message.
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]
Indicates where data appears in the message.
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.
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 message.
offset (float) -- [REQUIRED]
Indicates where data appears in the CAN message.
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]
Indicates where data appears in the message.
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.
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).
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).
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.
Retrieves information for each created fleet in an Amazon Web Services account.
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_fleets(
nextToken='string',
maxResults=123
)
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
{
'fleetSummaries': [
{
'id': 'string',
'arn': 'string',
'description': 'string',
'signalCatalogArn': 'string',
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
fleetSummaries (list) --
A list of information for each fleet.
(dict) --
Information about a fleet.
You can use the API operation to return this information about multiple fleets.
id (string) --
The unique ID of the fleet.
arn (string) --
The Amazon Resource Name (ARN) of the fleet.
description (string) --
A brief description of the fleet.
signalCatalogArn (string) --
The ARN of the signal catalog associated with the fleet.
creationTime (datetime) --
The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
lastModificationTime (datetime) --
The time the fleet 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.
Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.
See also: AWS API Documentation
Request Syntax
client.delete_campaign(
name='string'
)
string
[REQUIRED]
The name of the campaign to delete.
dict
Response Syntax
{
'name': 'string',
'arn': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the deleted campaign.
arn (string) --
The Amazon Resource Name (ARN) of the deleted campaign.
Note
The ARN isn’t returned if a campaign doesn’t exist.
Retrieves a list of summaries of all vehicles associated with a fleet.
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_vehicles_in_fleet(
fleetId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The ID of a fleet.
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
{
'vehicles': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
vehicles (list) --
A list of vehicles associated with the fleet.
(string) --
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
Retrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud.
For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.
Note
This API operation doesn't require input parameters.
See also: AWS API Documentation
Request Syntax
client.get_register_account_status()
dict
Response Syntax
{
'customerAccountId': 'string',
'accountStatus': 'REGISTRATION_PENDING'|'REGISTRATION_SUCCESS'|'REGISTRATION_FAILURE',
'timestreamRegistrationResponse': {
'timestreamDatabaseName': 'string',
'timestreamTableName': 'string',
'timestreamDatabaseArn': 'string',
'timestreamTableArn': 'string',
'registrationStatus': 'REGISTRATION_PENDING'|'REGISTRATION_SUCCESS'|'REGISTRATION_FAILURE',
'errorMessage': 'string'
},
'iamRegistrationResponse': {
'roleArn': 'string',
'registrationStatus': 'REGISTRATION_PENDING'|'REGISTRATION_SUCCESS'|'REGISTRATION_FAILURE',
'errorMessage': 'string'
},
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
customerAccountId (string) --
The unique ID of the Amazon Web Services account, provided at account creation.
accountStatus (string) --
The status of registering your account and resources. The status can be one of:
REGISTRATION_SUCCESS - The Amazon Web Services resource is successfully registered.
REGISTRATION_PENDING - Amazon Web Services IoT FleetWise is processing the registration request. This process takes approximately five minutes to complete.
REGISTRATION_FAILURE - Amazon Web Services IoT FleetWise can't register the AWS resource. Try again later.
timestreamRegistrationResponse (dict) --
Information about the registered Amazon Timestream resources or errors, if any.
timestreamDatabaseName (string) --
The name of the Timestream database.
timestreamTableName (string) --
The name of the Timestream database table.
timestreamDatabaseArn (string) --
The Amazon Resource Name (ARN) of the Timestream database.
timestreamTableArn (string) --
The ARN of the Timestream database table.
registrationStatus (string) --
The status of registering your Amazon Timestream resources. The status can be one of REGISTRATION_SUCCESS , REGISTRATION_PENDING , REGISTRATION_FAILURE .
errorMessage (string) --
A message associated with a registration error.
iamRegistrationResponse (dict) --
Information about the registered IAM resources or errors, if any.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to register.
registrationStatus (string) --
The status of registering your IAM resource. The status can be one of REGISTRATION_SUCCESS , REGISTRATION_PENDING , REGISTRATION_FAILURE .
errorMessage (string) --
A message associated with a registration error.
creationTime (datetime) --
The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).
lastModificationTime (datetime) --
The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
Deletes a vehicle model (model manifest).
Note
If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
See also: AWS API Documentation
Request Syntax
client.delete_model_manifest(
name='string'
)
string
[REQUIRED]
The name of the model manifest to delete.
dict
Response Syntax
{
'name': 'string',
'arn': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the deleted model manifest.
arn (string) --
The Amazon Resource Name (ARN) of the deleted model manifest.
Deletes a fleet. Before you delete a fleet, all vehicles must be dissociated from the fleet. For more information, see Delete a fleet (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide .
Note
If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
See also: AWS API Documentation
Request Syntax
client.delete_fleet(
fleetId='string'
)
string
[REQUIRED]
The ID of the fleet to delete.
dict
Response Syntax
{
'id': 'string',
'arn': 'string'
}
Response Structure
(dict) --
id (string) --
The ID of the deleted fleet.
arn (string) --
The Amazon Resource Name (ARN) of the deleted fleet.
Creates a decoder manifest using your existing CAN DBC file from your local device.
See also: AWS API Documentation
Request Syntax
client.import_decoder_manifest(
name='string',
networkFileDefinitions=[
{
'canDbc': {
'networkInterface': 'string',
'canDbcFiles': [
b'bytes',
],
'signalsMap': {
'string': 'string'
}
}
},
]
)
string
[REQUIRED]
The name of the decoder manifest to import.
list
[REQUIRED]
The file to load into an Amazon Web Services account.
(dict) --
Specifications for defining a vehicle network.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: canDbc.
canDbc (dict) --
Information, including CAN DBC files, about the configurations used to create a decoder manifest.
networkInterface (string) -- [REQUIRED]
Contains information about a network interface.
canDbcFiles (list) -- [REQUIRED]
A list of DBC files. You can upload only one DBC file for each network interface and specify up to five (inclusive) files in the list.
(bytes) --
signalsMap (dict) --
Pairs every signal specified in your vehicle model with a signal decoder.
(string) --
(string) --
dict
Response Syntax
{
'name': 'string',
'arn': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the imported decoder manifest.
arn (string) --
The Amazon Resource Name (ARN) of the decoder manifest that was imported.
Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle.
Note
If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
See also: AWS API Documentation
Request Syntax
client.disassociate_vehicle_fleet(
vehicleName='string',
fleetId='string'
)
string
[REQUIRED]
The unique ID of the vehicle to disassociate from the fleet.
string
[REQUIRED]
The unique ID of a fleet.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a list of summaries of created vehicles.
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_vehicles(
modelManifestArn='string',
nextToken='string',
maxResults=123
)
string
The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional parameter to list only the vehicles created from a certain vehicle model.
string
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
{
'vehicleSummaries': [
{
'vehicleName': 'string',
'arn': 'string',
'modelManifestArn': 'string',
'decoderManifestArn': 'string',
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
vehicleSummaries (list) --
A list of vehicles and information about them.
(dict) --
Information about a vehicle.
To return this information about vehicles in your account, you can use the API operation.
vehicleName (string) --
The unique ID of the vehicle.
arn (string) --
The Amazon Resource Name (ARN) of the vehicle.
modelManifestArn (string) --
The ARN of a vehicle model (model manifest) associated with the vehicle.
decoderManifestArn (string) --
The ARN of a decoder manifest associated with the vehicle.
creationTime (datetime) --
The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
lastModificationTime (datetime) --
The time the vehicle 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.
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',
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1)
}
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).
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',
'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
}
},
],
networkInterfaces=[
{
'interfaceId': 'string',
'type': 'CAN_INTERFACE'|'OBD_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
}
},
],
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 message.
offset (float) -- [REQUIRED]
Indicates where data appears in the CAN message.
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]
Indicates where data appears in the message.
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.
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).
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.
Retrieves a list of IDs for all fleets that the vehicle is associated with.
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_fleets_for_vehicle(
vehicleName='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The ID of the vehicle to retrieve 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
{
'fleets': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
fleets (list) --
A list of fleet IDs that the vehicle is associated with.
(string) --
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
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'
},
'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
},
'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'
},
'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'
}
},
],
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.
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.
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.
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.
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.
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.
Creates a group, or batch, of vehicles.
Note
You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle.
For more information, see Create multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide .
See also: AWS API Documentation
Request Syntax
client.batch_create_vehicle(
vehicles=[
{
'vehicleName': 'string',
'modelManifestArn': 'string',
'decoderManifestArn': 'string',
'attributes': {
'string': 'string'
},
'associationBehavior': 'CreateIotThing'|'ValidateIotThingExists',
'tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
list
[REQUIRED]
A list of information about each vehicle to create. For more information, see the API data type.
(dict) --
Information about the vehicle to create.
vehicleName (string) -- [REQUIRED]
The unique ID of the vehicle to create.
modelManifestArn (string) -- [REQUIRED]
The ARN of the vehicle model (model manifest) to create the vehicle from.
decoderManifestArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
attributes (dict) --
Static information about a vehicle in a key-value pair. For example: "engine Type" : "v6"
(string) --
(string) --
associationBehavior (string) --
An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
tags (list) --
Metadata which can be used to manage the vehicle.
(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
{
'vehicles': [
{
'vehicleName': 'string',
'arn': 'string',
'thingArn': 'string'
},
],
'errors': [
{
'vehicleName': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
vehicles (list) --
A list of information about a batch of created vehicles. For more information, see the API data type.
(dict) --
Information about a created vehicle.
vehicleName (string) --
The unique ID of the vehicle to create.
arn (string) --
The ARN of the created vehicle.
thingArn (string) --
The ARN of a created or validated Amazon Web Services IoT thing.
errors (list) --
A list of information about creation errors, or an empty list if there aren't any errors.
(dict) --
An HTTP error resulting from creating a vehicle.
vehicleName (string) --
The ID of the vehicle with the error.
code (string) --
An HTTP error code.
message (string) --
A description of the HTTP error.
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'
},
'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
},
'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'
},
'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'
}
},
],
'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 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.
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.
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.
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.
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
Retrieves information about the status of a vehicle with any associated campaigns.
See also: AWS API Documentation
Request Syntax
client.get_vehicle_status(
nextToken='string',
maxResults=123,
vehicleName='string'
)
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.
string
[REQUIRED]
The ID of the vehicle to retrieve information about.
dict
Response Syntax
{
'campaigns': [
{
'campaignName': 'string',
'vehicleName': 'string',
'status': 'CREATED'|'READY'|'HEALTHY'|'SUSPENDED'|'DELETING'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
campaigns (list) --
Lists information about the state of the vehicle with deployed campaigns.
(dict) --
Information about the state of a vehicle and how it relates to the status of a campaign.
campaignName (string) --
The name of a campaign.
vehicleName (string) --
The unique ID of the vehicle.
status (string) --
The state of a vehicle, which can be one of the following:
CREATED - Amazon Web Services IoT FleetWise sucessfully created the vehicle.
READY - The vehicle is ready to receive a campaign deployment.
HEALTHY - A campaign deployment was delivered to the vehicle.
SUSPENDED - A campaign associated with the vehicle was suspended and data collection was paused.
DELETING - Amazon Web Services IoT FleetWise is removing a campaign from the vehicle.
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
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',
'canInterface': {
'name': 'string',
'protocolName': 'string',
'protocolVersion': 'string'
},
'obdInterface': {
'name': 'string',
'requestMessageId': 123,
'obdStandard': 'string',
'pidRequestIntervalSeconds': 123,
'dtcRequestIntervalSeconds': 123,
'useExtendedIds': True|False,
'hasTransmissionEcu': True|False
}
},
],
'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).
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
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'
},
]
)
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 won't be collected after the campaign expires.
Default: 253402243200 (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.
Note
If a signal changes often, you might want to collect data at a slower rate.
dict
[REQUIRED]
The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: timeBasedCollectionScheme, conditionBasedCollectionScheme.
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.
Note
If a signal changes often, you might want to collect data at a slower rate.
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.
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.
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.
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',
'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.
Deletes a signal catalog.
Note
If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
See also: AWS API Documentation
Request Syntax
client.delete_signal_catalog(
name='string'
)
string
[REQUIRED]
The name of the signal catalog to delete.
dict
Response Syntax
{
'name': 'string',
'arn': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the deleted signal catalog.
arn (string) --
The Amazon Resource Name (ARN) of the deleted signal catalog.
Retrieves the logging options.
See also: AWS API Documentation
Request Syntax
client.get_logging_options()
dict
Response Syntax
{
'cloudWatchLogDelivery': {
'logType': 'OFF'|'ERROR',
'logGroupName': 'string'
}
}
Response Structure
(dict) --
cloudWatchLogDelivery (dict) --
Returns information about log delivery to Amazon CloudWatch Logs.
logType (string) --
The type of log to send data to Amazon CloudWatch Logs.
logGroupName (string) --
The Amazon CloudWatch Logs group the operation sends data to.
Updates a group, or batch, of vehicles.
Note
You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle.
For more information, see Update multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide .
See also: AWS API Documentation
Request Syntax
client.batch_update_vehicle(
vehicles=[
{
'vehicleName': 'string',
'modelManifestArn': 'string',
'decoderManifestArn': 'string',
'attributes': {
'string': 'string'
},
'attributeUpdateMode': 'Overwrite'|'Merge'
},
]
)
list
[REQUIRED]
A list of information about the vehicles to update. For more information, see the API data type.
(dict) --
Information about the vehicle to update.
vehicleName (string) -- [REQUIRED]
The unique ID of the vehicle to update.
modelManifestArn (string) --
The ARN of the vehicle model (model manifest) associated with the vehicle to update.
decoderManifestArn (string) --
The ARN of the signal decoder manifest associated with the vehicle to update.
attributes (dict) --
Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
(string) --
(string) --
attributeUpdateMode (string) --
The method the specified attributes will update the existing attributes on the vehicle. Use Overwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.
This is required if attributes are present in the input.
dict
Response Syntax
{
'vehicles': [
{
'vehicleName': 'string',
'arn': 'string'
},
],
'errors': [
{
'vehicleName': 'string',
'code': 123,
'message': 'string'
},
]
}
Response Structure
(dict) --
vehicles (list) --
A list of information about the batch of updated vehicles.
Note
This list contains only unique IDs for the vehicles that were updated.
(dict) --
Information about the updated vehicle.
vehicleName (string) --
The unique ID of the updated vehicle.
arn (string) --
The Amazon Resource Name (ARN) of the updated vehicle.
errors (list) --
A list of information about errors returned while updating a batch of vehicles, or, if there aren't any errors, an empty list.
(dict) --
An HTTP error resulting from updating the description for a vehicle.
vehicleName (string) --
The ID of the vehicle with the error.
code (integer) --
The relevant HTTP error code (400+).
message (string) --
A message associated with the error.
Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.
Note
An Amazon Web Services account is not the same thing as a "user account". An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and takes the form of either an IAM user or an IAM role, both with credentials. A single Amazon Web Services account can, and typically does, contain many users and roles.
See also: AWS API Documentation
Request Syntax
client.register_account(
timestreamResources={
'timestreamDatabaseName': 'string',
'timestreamTableName': 'string'
},
iamResources={
'roleArn': 'string'
}
)
dict
[REQUIRED]
The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.
timestreamDatabaseName (string) -- [REQUIRED]
The name of the registered Amazon Timestream database.
timestreamTableName (string) -- [REQUIRED]
The name of the registered Amazon Timestream database table.
dict
The IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream. For example, arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN .
dict
Response Syntax
{
'registerAccountStatus': 'REGISTRATION_PENDING'|'REGISTRATION_SUCCESS'|'REGISTRATION_FAILURE',
'timestreamResources': {
'timestreamDatabaseName': 'string',
'timestreamTableName': 'string'
},
'iamResources': {
'roleArn': 'string'
},
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
registerAccountStatus (string) --
The status of registering your Amazon Web Services account, IAM role, and Timestream resources.
timestreamResources (dict) --
The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.
timestreamDatabaseName (string) --
The name of the registered Amazon Timestream database.
timestreamTableName (string) --
The name of the registered Amazon Timestream database table.
iamResources (dict) --
The registered IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream. For example, arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN .
creationTime (datetime) --
The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).
lastModificationTime (datetime) --
The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
Creates or updates the logging option.
See also: AWS API Documentation
Request Syntax
client.put_logging_options(
cloudWatchLogDelivery={
'logType': 'OFF'|'ERROR',
'logGroupName': 'string'
}
)
dict
[REQUIRED]
Creates or updates the log delivery option to Amazon CloudWatch Logs.
logType (string) -- [REQUIRED]
The type of log to send data to Amazon CloudWatch Logs.
logGroupName (string) --
The Amazon CloudWatch Logs group the operation sends data to.
dict
Response Syntax
{}
Response Structure
(dict) --
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
},
'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.
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.
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ARN of the resource.
list
[REQUIRED]
The new or modified tags for the resource.
(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
{}
Response Structure
(dict) --
Updates a campaign.
See also: AWS API Documentation
Request Syntax
client.update_campaign(
name='string',
description='string',
dataExtraDimensions=[
'string',
],
action='APPROVE'|'SUSPEND'|'RESUME'|'UPDATE'
)
string
[REQUIRED]
The name of the campaign to update.
string
The description of the campaign.
list
A list of vehicle attributes to associate with a signal.
Default: An empty array
(string) --
string
[REQUIRED]
Specifies how to update a campaign. The action can be one of the following:
APPROVE - To approve delivering a data collection scheme to vehicles.
SUSPEND - To suspend collecting signal data.
RESUME - To resume collecting signal data.
UPDATE - To update a campaign.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'status': 'CREATING'|'WAITING_FOR_APPROVAL'|'RUNNING'|'SUSPENDED'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the campaign.
name (string) --
The name of the updated campaign.
status (string) --
The state of a campaign. The status can be one of:
CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.
WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.
RUNNING - The campaign is active.
SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.
Updates the description of an existing fleet.
Note
If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty HTTP body.
See also: AWS API Documentation
Request Syntax
client.update_fleet(
fleetId='string',
description='string'
)
string
[REQUIRED]
The ID of the fleet to update.
string
An updated description of the fleet.
dict
Response Syntax
{
'id': 'string',
'arn': 'string'
}
Response Structure
(dict) --
id (string) --
The ID of the updated fleet.
arn (string) --
The Amazon Resource Name (ARN) of the updated fleet.
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'
)
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.
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',
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1)
},
],
'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).
nextToken (string) --
The token to retrieve the next set of results, or null if there are no more results.
Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it.
Note
If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
See also: AWS API Documentation
Request Syntax
client.delete_decoder_manifest(
name='string'
)
string
[REQUIRED]
The name of the decoder manifest to delete.
dict
Response Syntax
{
'name': 'string',
'arn': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the deleted decoder manifest.
arn (string) --
The Amazon Resource Name (ARN) of the deleted decoder manifest.
Deletes a vehicle and removes it from any campaigns.
Note
If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
See also: AWS API Documentation
Request Syntax
client.delete_vehicle(
vehicleName='string'
)
string
[REQUIRED]
The ID of the vehicle to delete.
dict
Response Syntax
{
'vehicleName': 'string',
'arn': 'string'
}
Response Structure
(dict) --
vehicleName (string) --
The ID of the deleted vehicle.
arn (string) --
The Amazon Resource Name (ARN) of the deleted vehicle.
Creates a fleet that represents a group of vehicles.
Note
You must create both a signal catalog and vehicles before you can create a fleet.
For more information, see Fleets in the Amazon Web Services IoT FleetWise Developer Guide .
See also: AWS API Documentation
Request Syntax
client.create_fleet(
fleetId='string',
description='string',
signalCatalogArn='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The unique ID of the fleet to create.
string
A brief description of the fleet to create.
string
[REQUIRED]
The Amazon Resource Name (ARN) of a signal catalog.
list
Metadata that can be used to manage the fleet.
(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
{
'id': 'string',
'arn': 'string'
}
Response Structure
(dict) --
id (string) --
The ID of the created fleet.
arn (string) --
The ARN of the created fleet.
Lists the tags (metadata) you have assigned to the resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceARN='string'
)
string
[REQUIRED]
The ARN of the resource.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
The list of tags assigned to the resource.
(dict) --
A set of key/value pairs that are used to manage the resource.
Key (string) --
The tag's key.
Value (string) --
The tag's value.
Creates a signal catalog using your existing VSS formatted content from your local device.
See also: AWS API Documentation
Request Syntax
client.import_signal_catalog(
name='string',
description='string',
vss={
'vssJson': 'string'
},
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the signal catalog to import.
string
A brief description of the signal catalog.
dict
The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise language used to describe and model signals in vehicle networks.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: vssJson.
vssJson (string) --
Provides the VSS in JSON format.
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 imported signal catalog.
arn (string) --
The Amazon Resource Name (ARN) of the imported signal catalog.
Retrieves information about a fleet.
See also: AWS API Documentation
Request Syntax
client.get_fleet(
fleetId='string'
)
string
[REQUIRED]
The ID of the fleet to retrieve information about.
dict
Response Syntax
{
'id': 'string',
'arn': 'string',
'description': 'string',
'signalCatalogArn': 'string',
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
id (string) --
The ID of the fleet.
arn (string) --
The Amazon Resource Name (ARN) of the fleet.
description (string) --
A brief description of the fleet.
signalCatalogArn (string) --
The ARN of a signal catalog associated with the fleet.
creationTime (datetime) --
The time the fleet was created in seconds since epoch (January 1, 1970 at midnight UTC time).
lastModificationTime (datetime) --
The time the fleet was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
Lists all the created signal catalogs in an Amazon Web Services account.
You can use to list information about each signal (node) 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_catalogs(
nextToken='string',
maxResults=123
)
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',
'creationTime': datetime(2015, 1, 1),
'lastModificationTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
summaries (list) --
A list of information about each signal catalog.
(dict) --
Information about a collection of standardized signals, which can be attributes, branches, sensors, or actuators.
name (string) --
The name of the signal catalog.
arn (string) --
The Amazon Resource Name (ARN) of the signal catalog.
creationTime (datetime) --
The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
lastModificationTime (datetime) --
The time the signal catalog 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.