IoTFleetWise ************ Client ====== class IoTFleetWise.Client A low-level client representing AWS IoT FleetWise Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of your vehicle data models, independent of the in-vehicle communication architecture, and define data collection rules to transfer only high-value data to the cloud. For more information, see What is Amazon Web Services IoT FleetWise? in the *Amazon Web Services IoT FleetWise Developer Guide*. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. import boto3 client = boto3.client('iotfleetwise') These are the available methods: * associate_vehicle_fleet * batch_create_vehicle * batch_update_vehicle * can_paginate * close * create_campaign * create_decoder_manifest * create_fleet * create_model_manifest * create_signal_catalog * create_state_template * create_vehicle * delete_campaign * delete_decoder_manifest * delete_fleet * delete_model_manifest * delete_signal_catalog * delete_state_template * delete_vehicle * disassociate_vehicle_fleet * get_campaign * get_decoder_manifest * get_encryption_configuration * get_fleet * get_logging_options * get_model_manifest * get_paginator * get_register_account_status * get_signal_catalog * get_state_template * get_vehicle * get_vehicle_status * get_waiter * import_decoder_manifest * import_signal_catalog * list_campaigns * list_decoder_manifest_network_interfaces * list_decoder_manifest_signals * list_decoder_manifests * list_fleets * list_fleets_for_vehicle * list_model_manifest_nodes * list_model_manifests * list_signal_catalog_nodes * list_signal_catalogs * list_state_templates * list_tags_for_resource * list_vehicles * list_vehicles_in_fleet * put_encryption_configuration * put_logging_options * register_account * tag_resource * untag_resource * update_campaign * update_decoder_manifest * update_fleet * update_model_manifest * update_signal_catalog * update_state_template * update_vehicle Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * GetVehicleStatus * ListCampaigns * ListDecoderManifestNetworkInterfaces * ListDecoderManifestSignals * ListDecoderManifests * ListFleets * ListFleetsForVehicle * ListModelManifestNodes * ListModelManifests * ListSignalCatalogNodes * ListSignalCatalogs * ListStateTemplates * ListVehicles * ListVehiclesInFleet IoTFleetWise / Paginator / ListVehicles ListVehicles ************ class IoTFleetWise.Paginator.ListVehicles paginator = client.get_paginator('list_vehicles') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetWise.Client.list_vehicles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( modelManifestArn='string', attributeNames=[ 'string', ], attributeValues=[ 'string', ], listResponseScope='METADATA_ONLY', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **modelManifestArn** (*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. * **attributeNames** (*list*) -- The fully qualified names of the attributes. You can use this optional parameter to list the vehicles containing all the attributes in the request. For example, "attributeNames" could be " "Vehicle.Body.Engine.Type, Vehicle.Color"" and the corresponding "attributeValues" could be " "1.3 L R2, Blue"" . In this case, the API will filter vehicles with an attribute name "Vehicle.Body.Engine.Type" that contains a value of "1.3 L R2" AND an attribute name "Vehicle.Color" that contains a value of " "Blue"". A request must contain unique values for the "attributeNames" filter and the matching number of "attributeValues" filters to return the subset of vehicles that match the attributes filter condition. * *(string) --* * **attributeValues** (*list*) -- Static information about a vehicle attribute value in string format. You can use this optional parameter in conjunction with "attributeNames" to list the vehicles containing all the "attributeValues" corresponding to the "attributeNames" filter. For example, "attributeValues" could be " "1.3 L R2, Blue"" and the corresponding "attributeNames" filter could be " "Vehicle.Body.Engine.Type, Vehicle.Color"". In this case, the API will filter vehicles with attribute name "Vehicle.Body.Engine.Type" that contains a value of "1.3 L R2" AND an attribute name "Vehicle.Color" that contains a value of " "Blue"". A request must contain unique values for the "attributeNames" filter and the matching number of "attributeValues" filter to return the subset of vehicles that match the attributes filter condition. * *(string) --* * **listResponseScope** (*string*) -- When you set the "listResponseScope" parameter to "METADATA_ONLY", the list response includes: vehicle name, Amazon Resource Name (ARN), creation time, and last modification time. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'vehicleSummaries': [ { 'vehicleName': 'string', 'arn': 'string', 'modelManifestArn': 'string', 'decoderManifestArn': 'string', 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1), 'attributes': { 'string': 'string' } }, ], '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). * **attributes** *(dict) --* Static information about a vehicle in a key-value pair. For example: ""engineType"" : ""1.3 L R2"" * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. IoTFleetWise / Paginator / ListStateTemplates ListStateTemplates ****************** class IoTFleetWise.Paginator.ListStateTemplates paginator = client.get_paginator('list_state_templates') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetWise.Client.list_state_templates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( listResponseScope='METADATA_ONLY', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **listResponseScope** (*string*) -- When you set the "listResponseScope" parameter to "METADATA_ONLY", the list response includes: state template ID, Amazon Resource Name (ARN), creation time, and last modification time. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'summaries': [ { 'name': 'string', 'arn': 'string', 'signalCatalogArn': 'string', 'description': 'string', 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1), 'id': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **summaries** *(list) --* A list of information about each state template. * *(dict) --* Information about a state template. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **name** *(string) --* The name of the state template. * **arn** *(string) --* The Amazon Resource Name (ARN) of the state template. * **signalCatalogArn** *(string) --* The Amazon Resource Name (ARN) of the signal catalog associated with the state template. * **description** *(string) --* A brief description of the state template. * **creationTime** *(datetime) --* The time the state template was created, in seconds since epoch (January 1, 1970 at midnight UTC time). * **lastModificationTime** *(datetime) --* The time the state template was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time). * **id** *(string) --* The unique ID of the state template. * **NextToken** *(string) --* A token to resume pagination. IoTFleetWise / Paginator / ListCampaigns ListCampaigns ************* class IoTFleetWise.Paginator.ListCampaigns paginator = client.get_paginator('list_campaigns') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetWise.Client.list_campaigns()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( status='string', listResponseScope='METADATA_ONLY', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **status** (*string*) -- An 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". * **listResponseScope** (*string*) -- When you set the "listResponseScope" parameter to "METADATA_ONLY", the list response includes: campaign name, Amazon Resource Name (ARN), creation time, and last modification time. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { '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) --* A token to resume pagination. IoTFleetWise / Paginator / ListVehiclesInFleet ListVehiclesInFleet ******************* class IoTFleetWise.Paginator.ListVehiclesInFleet paginator = client.get_paginator('list_vehicles_in_fleet') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetWise.Client.list_vehicles_in_fleet()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( fleetId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **fleetId** (*string*) -- **[REQUIRED]** The ID of a fleet. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'vehicles': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **vehicles** *(list) --* A list of vehicles associated with the fleet. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. IoTFleetWise / Paginator / ListModelManifestNodes ListModelManifestNodes ********************** class IoTFleetWise.Paginator.ListModelManifestNodes paginator = client.get_paginator('list_model_manifest_nodes') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetWise.Client.list_model_manifest_nodes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( name='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the vehicle model to list information about. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'nodes': [ { 'branch': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'sensor': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'actuator': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'attribute': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'defaultValue': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'struct': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'property': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'dataEncoding': 'BINARY'|'TYPED', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **nodes** *(list) --* A list of information about nodes. * *(dict) --* A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "branch", "sensor", "actuator", "attribute", "struct", "property". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **branch** *(dict) --* Information about a node specified as a branch. Note: A group of signals that are defined in a hierarchical structure. * **fullyQualifiedName** *(string) --* The fully qualified name of the branch. For example, the fully qualified name of a branch might be "Vehicle.Body.Engine". * **description** *(string) --* A brief description of the branch. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **sensor** *(dict) --* An input component that reports the environmental condition of a vehicle. Note: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors. * **fullyQualifiedName** *(string) --* The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be "Vehicle.Body.Engine.Battery". * **dataType** *(string) --* The specified data type of the sensor. * **description** *(string) --* A brief description of a sensor. * **unit** *(string) --* The scientific unit of measurement for data collected by the sensor. * **allowedValues** *(list) --* A list of possible values a sensor can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of the sensor. * **max** *(float) --* The specified possible maximum value of the sensor. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for a sensor if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of a sensor might be "Vehicle.ADAS.CameraStruct". * **actuator** *(dict) --* Information about a node specified as an actuator. Note: An actuator is a digital representation of a vehicle device. * **fullyQualifiedName** *(string) --* The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be "Vehicle.Front.Left.Door.Lock". * **dataType** *(string) --* The specified data type of the actuator. * **description** *(string) --* A brief description of the actuator. * **unit** *(string) --* The scientific unit for the actuator. * **allowedValues** *(list) --* A list of possible values an actuator can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of an actuator. * **max** *(float) --* The specified possible maximum value of an actuator. * **assignedValue** *(string) --* A specified value for the actuator. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the actuator if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of an actuator might be "Vehicle.Door.LockStruct". * **attribute** *(dict) --* Information about a node specified as an attribute. Note: An attribute represents static information about a vehicle. * **fullyQualifiedName** *(string) --* The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be "Vehicle.Body.Engine.Type". * **dataType** *(string) --* The specified data type of the attribute. * **description** *(string) --* A brief description of the attribute. * **unit** *(string) --* The scientific unit for the attribute. * **allowedValues** *(list) --* A list of possible values an attribute can be assigned. * *(string) --* * **min** *(float) --* The specified possible minimum value of the attribute. * **max** *(float) --* The specified possible maximum value of the attribute. * **assignedValue** *(string) --* A specified value for the attribute. * **defaultValue** *(string) --* The default value of the attribute. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **struct** *(dict) --* Represents a complex or higher-order data structure. * **fullyQualifiedName** *(string) --* The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be "ComplexDataTypes.VehicleDataTypes.SVMCamera". * **description** *(string) --* A brief description of the custom structure. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **property** *(dict) --* Represents a member of the complex data structure. The "datatype" of the property can be either primitive or another "struct". * **fullyQualifiedName** *(string) --* The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be "ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS". * **dataType** *(string) --* The data type for the custom property. * **dataEncoding** *(string) --* Indicates whether the property is binary data. * **description** *(string) --* A brief description of the custom property. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the custom property if the data type of the custom property is "Struct" or "StructArray". * **NextToken** *(string) --* A token to resume pagination. IoTFleetWise / Paginator / ListModelManifests ListModelManifests ****************** class IoTFleetWise.Paginator.ListModelManifests paginator = client.get_paginator('list_model_manifests') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetWise.Client.list_model_manifests()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( signalCatalogArn='string', listResponseScope='METADATA_ONLY', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **signalCatalogArn** (*string*) -- The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned. * **listResponseScope** (*string*) -- When you set the "listResponseScope" parameter to "METADATA_ONLY", the list response includes: model manifest name, Amazon Resource Name (ARN), creation time, and last modification time. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'summaries': [ { 'name': 'string', 'arn': 'string', 'signalCatalogArn': 'string', 'description': 'string', 'status': 'ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING', 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **summaries** *(list) --* A list of information about vehicle models. * *(dict) --* Information about a vehicle model (model manifest). You can use the API operation to return this information about multiple vehicle models. * **name** *(string) --* The name of the vehicle model. * **arn** *(string) --* The Amazon Resource Name (ARN) of the vehicle model. * **signalCatalogArn** *(string) --* The ARN of the signal catalog associated with the vehicle model. * **description** *(string) --* A brief description of the vehicle model. * **status** *(string) --* The state of the vehicle model. If the status is "ACTIVE", the vehicle model can't be edited. If the status is "DRAFT", you can edit the vehicle model. * **creationTime** *(datetime) --* The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time). * **lastModificationTime** *(datetime) --* The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time). * **NextToken** *(string) --* A token to resume pagination. IoTFleetWise / Paginator / ListSignalCatalogs ListSignalCatalogs ****************** class IoTFleetWise.Paginator.ListSignalCatalogs paginator = client.get_paginator('list_signal_catalogs') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetWise.Client.list_signal_catalogs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { '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) --* A token to resume pagination. IoTFleetWise / Paginator / ListSignalCatalogNodes ListSignalCatalogNodes ********************** class IoTFleetWise.Paginator.ListSignalCatalogNodes paginator = client.get_paginator('list_signal_catalog_nodes') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetWise.Client.list_signal_catalog_nodes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( name='string', signalNodeType='SENSOR'|'ACTUATOR'|'ATTRIBUTE'|'BRANCH'|'CUSTOM_STRUCT'|'CUSTOM_PROPERTY', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the signal catalog to list information about. * **signalNodeType** (*string*) -- The type of node in the signal catalog. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'nodes': [ { 'branch': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'sensor': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'actuator': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'attribute': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'defaultValue': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'struct': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'property': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'dataEncoding': 'BINARY'|'TYPED', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **nodes** *(list) --* A list of information about nodes. * *(dict) --* A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "branch", "sensor", "actuator", "attribute", "struct", "property". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **branch** *(dict) --* Information about a node specified as a branch. Note: A group of signals that are defined in a hierarchical structure. * **fullyQualifiedName** *(string) --* The fully qualified name of the branch. For example, the fully qualified name of a branch might be "Vehicle.Body.Engine". * **description** *(string) --* A brief description of the branch. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **sensor** *(dict) --* An input component that reports the environmental condition of a vehicle. Note: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors. * **fullyQualifiedName** *(string) --* The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be "Vehicle.Body.Engine.Battery". * **dataType** *(string) --* The specified data type of the sensor. * **description** *(string) --* A brief description of a sensor. * **unit** *(string) --* The scientific unit of measurement for data collected by the sensor. * **allowedValues** *(list) --* A list of possible values a sensor can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of the sensor. * **max** *(float) --* The specified possible maximum value of the sensor. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for a sensor if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of a sensor might be "Vehicle.ADAS.CameraStruct". * **actuator** *(dict) --* Information about a node specified as an actuator. Note: An actuator is a digital representation of a vehicle device. * **fullyQualifiedName** *(string) --* The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be "Vehicle.Front.Left.Door.Lock". * **dataType** *(string) --* The specified data type of the actuator. * **description** *(string) --* A brief description of the actuator. * **unit** *(string) --* The scientific unit for the actuator. * **allowedValues** *(list) --* A list of possible values an actuator can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of an actuator. * **max** *(float) --* The specified possible maximum value of an actuator. * **assignedValue** *(string) --* A specified value for the actuator. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the actuator if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of an actuator might be "Vehicle.Door.LockStruct". * **attribute** *(dict) --* Information about a node specified as an attribute. Note: An attribute represents static information about a vehicle. * **fullyQualifiedName** *(string) --* The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be "Vehicle.Body.Engine.Type". * **dataType** *(string) --* The specified data type of the attribute. * **description** *(string) --* A brief description of the attribute. * **unit** *(string) --* The scientific unit for the attribute. * **allowedValues** *(list) --* A list of possible values an attribute can be assigned. * *(string) --* * **min** *(float) --* The specified possible minimum value of the attribute. * **max** *(float) --* The specified possible maximum value of the attribute. * **assignedValue** *(string) --* A specified value for the attribute. * **defaultValue** *(string) --* The default value of the attribute. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **struct** *(dict) --* Represents a complex or higher-order data structure. * **fullyQualifiedName** *(string) --* The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be "ComplexDataTypes.VehicleDataTypes.SVMCamera". * **description** *(string) --* A brief description of the custom structure. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **property** *(dict) --* Represents a member of the complex data structure. The "datatype" of the property can be either primitive or another "struct". * **fullyQualifiedName** *(string) --* The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be "ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS". * **dataType** *(string) --* The data type for the custom property. * **dataEncoding** *(string) --* Indicates whether the property is binary data. * **description** *(string) --* A brief description of the custom property. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the custom property if the data type of the custom property is "Struct" or "StructArray". * **NextToken** *(string) --* A token to resume pagination. IoTFleetWise / Paginator / ListDecoderManifests ListDecoderManifests ******************** class IoTFleetWise.Paginator.ListDecoderManifests paginator = client.get_paginator('list_decoder_manifests') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetWise.Client.list_decoder_manifests()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( modelManifestArn='string', listResponseScope='METADATA_ONLY', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **modelManifestArn** (*string*) -- The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest. * **listResponseScope** (*string*) -- When you set the "listResponseScope" parameter to "METADATA_ONLY", the list response includes: decoder manifest name, Amazon Resource Name (ARN), creation time, and last modification time. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'summaries': [ { 'name': 'string', 'arn': 'string', 'modelManifestArn': 'string', 'description': 'string', 'status': 'ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING', 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1), 'message': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **summaries** *(list) --* A list of information about each decoder manifest. * *(dict) --* Information about a created decoder manifest. You can use the API operation to return this information about multiple decoder manifests. * **name** *(string) --* The name of the decoder manifest. * **arn** *(string) --* The ARN of a vehicle model (model manifest) associated with the decoder manifest. * **modelManifestArn** *(string) --* The ARN of a vehicle model (model manifest) associated with the decoder manifest. * **description** *(string) --* A brief description of the decoder manifest. * **status** *(string) --* The state of the decoder manifest. If the status is "ACTIVE", the decoder manifest can't be edited. If the status is marked "DRAFT", you can edit the decoder manifest. * **creationTime** *(datetime) --* The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time). * **lastModificationTime** *(datetime) --* The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). * **message** *(string) --* The detailed message for the decoder manifest. When a decoder manifest is in an "INVALID" status, the message contains detailed reason and help information. * **NextToken** *(string) --* A token to resume pagination. IoTFleetWise / Paginator / ListFleetsForVehicle ListFleetsForVehicle ******************** class IoTFleetWise.Paginator.ListFleetsForVehicle paginator = client.get_paginator('list_fleets_for_vehicle') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetWise.Client.list_fleets_for_vehicle()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( vehicleName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **vehicleName** (*string*) -- **[REQUIRED]** The ID of the vehicle to retrieve information about. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'fleets': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **fleets** *(list) --* A list of fleet IDs that the vehicle is associated with. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. IoTFleetWise / Paginator / ListFleets ListFleets ********** class IoTFleetWise.Paginator.ListFleets paginator = client.get_paginator('list_fleets') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetWise.Client.list_fleets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( listResponseScope='METADATA_ONLY', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **listResponseScope** (*string*) -- When you set the "listResponseScope" parameter to "METADATA_ONLY", the list response includes: fleet ID, Amazon Resource Name (ARN), creation time, and last modification time. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { '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) --* A token to resume pagination. IoTFleetWise / Paginator / ListDecoderManifestNetworkInterfaces ListDecoderManifestNetworkInterfaces ************************************ class IoTFleetWise.Paginator.ListDecoderManifestNetworkInterfaces paginator = client.get_paginator('list_decoder_manifest_network_interfaces') paginate(**kwargs) Creates an iterator that will paginate through responses from " IoTFleetWise.Client.list_decoder_manifest_network_interfaces()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( name='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the decoder manifest to list information about. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'networkInterfaces': [ { 'interfaceId': 'string', 'type': 'CAN_INTERFACE'|'OBD_INTERFACE'|'VEHICLE_MIDDLEWARE'|'CUSTOM_DECODING_INTERFACE', 'canInterface': { 'name': 'string', 'protocolName': 'string', 'protocolVersion': 'string' }, 'obdInterface': { 'name': 'string', 'requestMessageId': 123, 'obdStandard': 'string', 'pidRequestIntervalSeconds': 123, 'dtcRequestIntervalSeconds': 123, 'useExtendedIds': True|False, 'hasTransmissionEcu': True|False }, 'vehicleMiddleware': { 'name': 'string', 'protocolName': 'ROS_2' }, 'customDecodingInterface': { 'name': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **networkInterfaces** *(list) --* A list of information about network interfaces. * *(dict) --* Represents a node and its specifications in an in- vehicle communication network. All signal decoders must be associated with a network node. To return this information about all the network interfaces specified in a decoder manifest, use the API operation. * **interfaceId** *(string) --* The ID of the network interface. * **type** *(string) --* The network protocol for the vehicle. For example, "CAN_SIGNAL" specifies a protocol that defines how data is communicated between electronic control units (ECUs). "OBD_SIGNAL" specifies a protocol that defines how self-diagnostic data is communicated between ECUs. * **canInterface** *(dict) --* Information about a network interface specified by the Controller Area Network (CAN) protocol. * **name** *(string) --* The unique name of the interface. * **protocolName** *(string) --* The name of the communication protocol for the interface. * **protocolVersion** *(string) --* The version of the communication protocol for the interface. * **obdInterface** *(dict) --* Information about a network interface specified by the on-board diagnostic (OBD) II protocol. * **name** *(string) --* The name of the interface. * **requestMessageId** *(integer) --* The ID of the message requesting vehicle data. * **obdStandard** *(string) --* The standard OBD II PID. * **pidRequestIntervalSeconds** *(integer) --* The maximum number message requests per second. * **dtcRequestIntervalSeconds** *(integer) --* The maximum number message requests per diagnostic trouble code per second. * **useExtendedIds** *(boolean) --* Whether to use extended IDs in the message. * **hasTransmissionEcu** *(boolean) --* Whether the vehicle has a transmission control module (TCM). * **vehicleMiddleware** *(dict) --* The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include "ROS2" and "SOME/IP". * **name** *(string) --* The name of the vehicle middleware. * **protocolName** *(string) --* The protocol name of the vehicle middleware. * **customDecodingInterface** *(dict) --* Information about a custom network interface. * **name** *(string) --* The name of the interface. * **NextToken** *(string) --* A token to resume pagination. IoTFleetWise / Paginator / GetVehicleStatus GetVehicleStatus **************** class IoTFleetWise.Paginator.GetVehicleStatus paginator = client.get_paginator('get_vehicle_status') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetWise.Client.get_vehicle_status()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( vehicleName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **vehicleName** (*string*) -- **[REQUIRED]** The ID of the vehicle to retrieve information about. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'campaigns': [ { 'campaignName': 'string', 'vehicleName': 'string', 'status': 'CREATED'|'READY'|'HEALTHY'|'SUSPENDED'|'DELETING'|'READY_FOR_CHECKIN' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **campaigns** *(list) --* Lists information about the state of the vehicle with deployed campaigns. * *(dict) --* Information about a campaign associated with a vehicle. * **campaignName** *(string) --* The name of a campaign. * **vehicleName** *(string) --* The unique ID of the vehicle. * **status** *(string) --* The status of a campaign, which can be one of the following: * "CREATED" - The campaign exists but is not yet approved. * "READY" - The campaign is approved but has not been deployed to the vehicle. Data has not arrived at the vehicle yet. * "HEALTHY" - The campaign is deployed to the vehicle. * "SUSPENDED" - The campaign is suspended and data collection is paused. * "DELETING" - The campaign is being removed from the vehicle. * "READY_FOR_CHECKIN" - The campaign is approved and waiting for vehicle check-in before deployment. * **NextToken** *(string) --* A token to resume pagination. IoTFleetWise / Paginator / ListDecoderManifestSignals ListDecoderManifestSignals ************************** class IoTFleetWise.Paginator.ListDecoderManifestSignals paginator = client.get_paginator('list_decoder_manifest_signals') paginate(**kwargs) Creates an iterator that will paginate through responses from "IoTFleetWise.Client.list_decoder_manifest_signals()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( name='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the decoder manifest to list information about. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'signalDecoders': [ { 'fullyQualifiedName': 'string', 'type': 'CAN_SIGNAL'|'OBD_SIGNAL'|'MESSAGE_SIGNAL'|'CUSTOM_DECODING_SIGNAL', 'interfaceId': 'string', 'canSignal': { 'messageId': 123, 'isBigEndian': True|False, 'isSigned': True|False, 'startBit': 123, 'offset': 123.0, 'factor': 123.0, 'length': 123, 'name': 'string', 'signalValueType': 'INTEGER'|'FLOATING_POINT' }, 'obdSignal': { 'pidResponseLength': 123, 'serviceMode': 123, 'pid': 123, 'scaling': 123.0, 'offset': 123.0, 'startByte': 123, 'byteLength': 123, 'bitRightShift': 123, 'bitMaskLength': 123, 'isSigned': True|False, 'signalValueType': 'INTEGER'|'FLOATING_POINT' }, 'messageSignal': { 'topicName': 'string', 'structuredMessage': { 'primitiveMessageDefinition': { 'ros2PrimitiveMessageDefinition': { 'primitiveType': 'BOOL'|'BYTE'|'CHAR'|'FLOAT32'|'FLOAT64'|'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'STRING'|'WSTRING', 'offset': 123.0, 'scaling': 123.0, 'upperBound': 123 } }, 'structuredMessageListDefinition': { 'name': 'string', 'memberType': {'... recursive ...'}, 'listType': 'FIXED_CAPACITY'|'DYNAMIC_UNBOUNDED_CAPACITY'|'DYNAMIC_BOUNDED_CAPACITY', 'capacity': 123 }, 'structuredMessageDefinition': [ { 'fieldName': 'string', 'dataType': {'... recursive ...'} }, ] } }, 'customDecodingSignal': { 'id': 'string' } }, ], '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) --* Determines whether the message is signed ( "true") or not ( "false"). If it's signed, the message can represent both positive and negative numbers. The "isSigned" parameter only applies to the "INTEGER" raw signal type, and it doesn't affect the "FLOATING_POINT" raw signal type. * **startBit** *(integer) --* Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB). This value might be different from the value in a DBC file. For little endian signals, "startBit" is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the "startBit". * **offset** *(float) --* The offset used to calculate the signal value. Combined with factor, the calculation is "value = raw_value * factor + offset". * **factor** *(float) --* A multiplier used to decode the CAN message. * **length** *(integer) --* How many bytes of data are in the message. * **name** *(string) --* The name of the signal. * **signalValueType** *(string) --* The value type of the signal. The default value is "INTEGER". * **obdSignal** *(dict) --* Information about signal decoder using the on-board diagnostic (OBD) II protocol. * **pidResponseLength** *(integer) --* The length of the requested data. * **serviceMode** *(integer) --* The mode of operation (diagnostic service) in a message. * **pid** *(integer) --* The diagnostic code used to request data from a vehicle for this signal. * **scaling** *(float) --* A multiplier used to decode the message. * **offset** *(float) --* The offset used to calculate the signal value. Combined with scaling, the calculation is "value = raw_value * scaling + offset". * **startByte** *(integer) --* Indicates the beginning of the message. * **byteLength** *(integer) --* The length of a message. * **bitRightShift** *(integer) --* The number of positions to shift bits in the message. * **bitMaskLength** *(integer) --* The number of bits to mask in a message. * **isSigned** *(boolean) --* Determines whether the message is signed ( "true") or not ( "false"). If it's signed, the message can represent both positive and negative numbers. The "isSigned" parameter only applies to the "INTEGER" raw signal type, and it doesn't affect the "FLOATING_POINT" raw signal type. The default value is "false". * **signalValueType** *(string) --* The value type of the signal. The default value is "INTEGER". * **messageSignal** *(dict) --* The decoding information for a specific message which supports higher order data types. * **topicName** *(string) --* The topic name for the message signal. It corresponds to topics in ROS 2. * **structuredMessage** *(dict) --* The structured message for the message signal. It can be defined with either a "primitiveMessageDefinition", "structuredMessageListDefinition", or "structuredMessageDefinition" recursively. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **primitiveMessageDefinition** *(dict) --* Represents a primitive type node of the complex data structure. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "ros2PrimitiveMessageDefinition". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **ros2PrimitiveMessageDefinition** *(dict) --* Information about a "PrimitiveMessage" using a ROS 2 compliant primitive type message of the complex data structure. * **primitiveType** *(string) --* The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition. * **offset** *(float) --* The offset used to calculate the signal value. Combined with scaling, the calculation is "value = raw_value * scaling + offset". * **scaling** *(float) --* A multiplier used to decode the message. * **upperBound** *(integer) --* An optional attribute specifying the upper bound for "STRING" and "WSTRING". * **structuredMessageListDefinition** *(dict) --* Represents a list type node of the complex data structure. * **name** *(string) --* The name of the structured message list definition. * **memberType** *(dict) --* The member type of the structured message list definition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **listType** *(string) --* The type of list of the structured message list definition. * **capacity** *(integer) --* The capacity of the structured message list definition when the list type is "FIXED_CAPACITY" or "DYNAMIC_BOUNDED_CAPACITY". * **structuredMessageDefinition** *(list) --* Represents a struct type node of the complex data structure. * *(dict) --* Represents a "StructureMessageName" to "DataType" map element. * **fieldName** *(string) --* The field name of the structured message. It determines how a data value is referenced in the target language. * **dataType** *(dict) --* The data type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **customDecodingSignal** *(dict) --* Information about a custom signal decoder. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **id** *(string) --* The ID of the signal. * **NextToken** *(string) --* A token to resume pagination. IoTFleetWise / Client / get_model_manifest get_model_manifest ****************** IoTFleetWise.Client.get_model_manifest(**kwargs) Retrieves information about a vehicle model (model manifest). See also: AWS API Documentation **Request Syntax** response = client.get_model_manifest( name='string' ) Parameters: **name** (*string*) -- **[REQUIRED]** The name of the vehicle model to retrieve information about. Return type: dict Returns: **Response Syntax** { 'name': 'string', 'arn': 'string', 'description': 'string', 'signalCatalogArn': 'string', 'status': 'ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING', 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **name** *(string) --* The name of the vehicle model. * **arn** *(string) --* The Amazon Resource Name (ARN) of the vehicle model. * **description** *(string) --* A brief description of the vehicle model. * **signalCatalogArn** *(string) --* The ARN of the signal catalog associated with the vehicle model. * **status** *(string) --* The state of the vehicle model. If the status is "ACTIVE", the vehicle model can't be edited. You can edit the vehicle model if the status is marked "DRAFT". * **creationTime** *(datetime) --* The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time). * **lastModificationTime** *(datetime) --* The last time the vehicle model was modified. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / update_decoder_manifest update_decoder_manifest *********************** IoTFleetWise.Client.update_decoder_manifest(**kwargs) 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** response = client.update_decoder_manifest( name='string', description='string', signalDecodersToAdd=[ { 'fullyQualifiedName': 'string', 'type': 'CAN_SIGNAL'|'OBD_SIGNAL'|'MESSAGE_SIGNAL'|'CUSTOM_DECODING_SIGNAL', 'interfaceId': 'string', 'canSignal': { 'messageId': 123, 'isBigEndian': True|False, 'isSigned': True|False, 'startBit': 123, 'offset': 123.0, 'factor': 123.0, 'length': 123, 'name': 'string', 'signalValueType': 'INTEGER'|'FLOATING_POINT' }, 'obdSignal': { 'pidResponseLength': 123, 'serviceMode': 123, 'pid': 123, 'scaling': 123.0, 'offset': 123.0, 'startByte': 123, 'byteLength': 123, 'bitRightShift': 123, 'bitMaskLength': 123, 'isSigned': True|False, 'signalValueType': 'INTEGER'|'FLOATING_POINT' }, 'messageSignal': { 'topicName': 'string', 'structuredMessage': { 'primitiveMessageDefinition': { 'ros2PrimitiveMessageDefinition': { 'primitiveType': 'BOOL'|'BYTE'|'CHAR'|'FLOAT32'|'FLOAT64'|'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'STRING'|'WSTRING', 'offset': 123.0, 'scaling': 123.0, 'upperBound': 123 } }, 'structuredMessageListDefinition': { 'name': 'string', 'memberType': {'... recursive ...'}, 'listType': 'FIXED_CAPACITY'|'DYNAMIC_UNBOUNDED_CAPACITY'|'DYNAMIC_BOUNDED_CAPACITY', 'capacity': 123 }, 'structuredMessageDefinition': [ { 'fieldName': 'string', 'dataType': {'... recursive ...'} }, ] } }, 'customDecodingSignal': { 'id': 'string' } }, ], signalDecodersToUpdate=[ { 'fullyQualifiedName': 'string', 'type': 'CAN_SIGNAL'|'OBD_SIGNAL'|'MESSAGE_SIGNAL'|'CUSTOM_DECODING_SIGNAL', 'interfaceId': 'string', 'canSignal': { 'messageId': 123, 'isBigEndian': True|False, 'isSigned': True|False, 'startBit': 123, 'offset': 123.0, 'factor': 123.0, 'length': 123, 'name': 'string', 'signalValueType': 'INTEGER'|'FLOATING_POINT' }, 'obdSignal': { 'pidResponseLength': 123, 'serviceMode': 123, 'pid': 123, 'scaling': 123.0, 'offset': 123.0, 'startByte': 123, 'byteLength': 123, 'bitRightShift': 123, 'bitMaskLength': 123, 'isSigned': True|False, 'signalValueType': 'INTEGER'|'FLOATING_POINT' }, 'messageSignal': { 'topicName': 'string', 'structuredMessage': { 'primitiveMessageDefinition': { 'ros2PrimitiveMessageDefinition': { 'primitiveType': 'BOOL'|'BYTE'|'CHAR'|'FLOAT32'|'FLOAT64'|'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'STRING'|'WSTRING', 'offset': 123.0, 'scaling': 123.0, 'upperBound': 123 } }, 'structuredMessageListDefinition': { 'name': 'string', 'memberType': {'... recursive ...'}, 'listType': 'FIXED_CAPACITY'|'DYNAMIC_UNBOUNDED_CAPACITY'|'DYNAMIC_BOUNDED_CAPACITY', 'capacity': 123 }, 'structuredMessageDefinition': [ { 'fieldName': 'string', 'dataType': {'... recursive ...'} }, ] } }, 'customDecodingSignal': { 'id': 'string' } }, ], signalDecodersToRemove=[ 'string', ], networkInterfacesToAdd=[ { 'interfaceId': 'string', 'type': 'CAN_INTERFACE'|'OBD_INTERFACE'|'VEHICLE_MIDDLEWARE'|'CUSTOM_DECODING_INTERFACE', 'canInterface': { 'name': 'string', 'protocolName': 'string', 'protocolVersion': 'string' }, 'obdInterface': { 'name': 'string', 'requestMessageId': 123, 'obdStandard': 'string', 'pidRequestIntervalSeconds': 123, 'dtcRequestIntervalSeconds': 123, 'useExtendedIds': True|False, 'hasTransmissionEcu': True|False }, 'vehicleMiddleware': { 'name': 'string', 'protocolName': 'ROS_2' }, 'customDecodingInterface': { 'name': 'string' } }, ], networkInterfacesToUpdate=[ { 'interfaceId': 'string', 'type': 'CAN_INTERFACE'|'OBD_INTERFACE'|'VEHICLE_MIDDLEWARE'|'CUSTOM_DECODING_INTERFACE', 'canInterface': { 'name': 'string', 'protocolName': 'string', 'protocolVersion': 'string' }, 'obdInterface': { 'name': 'string', 'requestMessageId': 123, 'obdStandard': 'string', 'pidRequestIntervalSeconds': 123, 'dtcRequestIntervalSeconds': 123, 'useExtendedIds': True|False, 'hasTransmissionEcu': True|False }, 'vehicleMiddleware': { 'name': 'string', 'protocolName': 'ROS_2' }, 'customDecodingInterface': { 'name': 'string' } }, ], networkInterfacesToRemove=[ 'string', ], status='ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING', defaultForUnmappedSignals='CUSTOM_DECODING' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the decoder manifest to update. * **description** (*string*) -- A brief description of the decoder manifest to update. * **signalDecodersToAdd** (*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]** Determines whether the message is signed ( "true") or not ( "false"). If it's signed, the message can represent both positive and negative numbers. The "isSigned" parameter only applies to the "INTEGER" raw signal type, and it doesn't affect the "FLOATING_POINT" raw signal type. * **startBit** *(integer) --* **[REQUIRED]** Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB). This value might be different from the value in a DBC file. For little endian signals, "startBit" is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the "startBit". * **offset** *(float) --* **[REQUIRED]** The offset used to calculate the signal value. Combined with factor, the calculation is "value = raw_value * factor + offset". * **factor** *(float) --* **[REQUIRED]** A multiplier used to decode the CAN message. * **length** *(integer) --* **[REQUIRED]** How many bytes of data are in the message. * **name** *(string) --* The name of the signal. * **signalValueType** *(string) --* The value type of the signal. The default value is "INTEGER". * **obdSignal** *(dict) --* Information about signal decoder using the on-board diagnostic (OBD) II protocol. * **pidResponseLength** *(integer) --* **[REQUIRED]** The length of the requested data. * **serviceMode** *(integer) --* **[REQUIRED]** The mode of operation (diagnostic service) in a message. * **pid** *(integer) --* **[REQUIRED]** The diagnostic code used to request data from a vehicle for this signal. * **scaling** *(float) --* **[REQUIRED]** A multiplier used to decode the message. * **offset** *(float) --* **[REQUIRED]** The offset used to calculate the signal value. Combined with scaling, the calculation is "value = raw_value * scaling + offset". * **startByte** *(integer) --* **[REQUIRED]** Indicates the beginning of the message. * **byteLength** *(integer) --* **[REQUIRED]** The length of a message. * **bitRightShift** *(integer) --* The number of positions to shift bits in the message. * **bitMaskLength** *(integer) --* The number of bits to mask in a message. * **isSigned** *(boolean) --* Determines whether the message is signed ( "true") or not ( "false"). If it's signed, the message can represent both positive and negative numbers. The "isSigned" parameter only applies to the "INTEGER" raw signal type, and it doesn't affect the "FLOATING_POINT" raw signal type. The default value is "false". * **signalValueType** *(string) --* The value type of the signal. The default value is "INTEGER". * **messageSignal** *(dict) --* The decoding information for a specific message which supports higher order data types. * **topicName** *(string) --* **[REQUIRED]** The topic name for the message signal. It corresponds to topics in ROS 2. * **structuredMessage** *(dict) --* **[REQUIRED]** The structured message for the message signal. It can be defined with either a "primitiveMessageDefinition", "structuredMessageListDefinition", or "structuredMessageDefinition" recursively. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". * **primitiveMessageDefinition** *(dict) --* Represents a primitive type node of the complex data structure. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "ros2PrimitiveMessageDefinition". * **ros2PrimitiveMessageDefinition** *(dict) --* Information about a "PrimitiveMessage" using a ROS 2 compliant primitive type message of the complex data structure. * **primitiveType** *(string) --* **[REQUIRED]** The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition. * **offset** *(float) --* The offset used to calculate the signal value. Combined with scaling, the calculation is "value = raw_value * scaling + offset". * **scaling** *(float) --* A multiplier used to decode the message. * **upperBound** *(integer) --* An optional attribute specifying the upper bound for "STRING" and "WSTRING". * **structuredMessageListDefinition** *(dict) --* Represents a list type node of the complex data structure. * **name** *(string) --* **[REQUIRED]** The name of the structured message list definition. * **memberType** *(dict) --* The member type of the structured message list definition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". * **listType** *(string) --* **[REQUIRED]** The type of list of the structured message list definition. * **capacity** *(integer) --* The capacity of the structured message list definition when the list type is "FIXED_CAPACITY" or "DYNAMIC_BOUNDED_CAPACITY". * **structuredMessageDefinition** *(list) --* Represents a struct type node of the complex data structure. * *(dict) --* Represents a "StructureMessageName" to "DataType" map element. * **fieldName** *(string) --* **[REQUIRED]** The field name of the structured message. It determines how a data value is referenced in the target language. * **dataType** *(dict) --* The data type. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". * **customDecodingSignal** *(dict) --* Information about a custom signal decoder. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **id** *(string) --* **[REQUIRED]** The ID of the signal. * **signalDecodersToUpdate** (*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]** Determines whether the message is signed ( "true") or not ( "false"). If it's signed, the message can represent both positive and negative numbers. The "isSigned" parameter only applies to the "INTEGER" raw signal type, and it doesn't affect the "FLOATING_POINT" raw signal type. * **startBit** *(integer) --* **[REQUIRED]** Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB). This value might be different from the value in a DBC file. For little endian signals, "startBit" is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the "startBit". * **offset** *(float) --* **[REQUIRED]** The offset used to calculate the signal value. Combined with factor, the calculation is "value = raw_value * factor + offset". * **factor** *(float) --* **[REQUIRED]** A multiplier used to decode the CAN message. * **length** *(integer) --* **[REQUIRED]** How many bytes of data are in the message. * **name** *(string) --* The name of the signal. * **signalValueType** *(string) --* The value type of the signal. The default value is "INTEGER". * **obdSignal** *(dict) --* Information about signal decoder using the on-board diagnostic (OBD) II protocol. * **pidResponseLength** *(integer) --* **[REQUIRED]** The length of the requested data. * **serviceMode** *(integer) --* **[REQUIRED]** The mode of operation (diagnostic service) in a message. * **pid** *(integer) --* **[REQUIRED]** The diagnostic code used to request data from a vehicle for this signal. * **scaling** *(float) --* **[REQUIRED]** A multiplier used to decode the message. * **offset** *(float) --* **[REQUIRED]** The offset used to calculate the signal value. Combined with scaling, the calculation is "value = raw_value * scaling + offset". * **startByte** *(integer) --* **[REQUIRED]** Indicates the beginning of the message. * **byteLength** *(integer) --* **[REQUIRED]** The length of a message. * **bitRightShift** *(integer) --* The number of positions to shift bits in the message. * **bitMaskLength** *(integer) --* The number of bits to mask in a message. * **isSigned** *(boolean) --* Determines whether the message is signed ( "true") or not ( "false"). If it's signed, the message can represent both positive and negative numbers. The "isSigned" parameter only applies to the "INTEGER" raw signal type, and it doesn't affect the "FLOATING_POINT" raw signal type. The default value is "false". * **signalValueType** *(string) --* The value type of the signal. The default value is "INTEGER". * **messageSignal** *(dict) --* The decoding information for a specific message which supports higher order data types. * **topicName** *(string) --* **[REQUIRED]** The topic name for the message signal. It corresponds to topics in ROS 2. * **structuredMessage** *(dict) --* **[REQUIRED]** The structured message for the message signal. It can be defined with either a "primitiveMessageDefinition", "structuredMessageListDefinition", or "structuredMessageDefinition" recursively. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". * **primitiveMessageDefinition** *(dict) --* Represents a primitive type node of the complex data structure. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "ros2PrimitiveMessageDefinition". * **ros2PrimitiveMessageDefinition** *(dict) --* Information about a "PrimitiveMessage" using a ROS 2 compliant primitive type message of the complex data structure. * **primitiveType** *(string) --* **[REQUIRED]** The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition. * **offset** *(float) --* The offset used to calculate the signal value. Combined with scaling, the calculation is "value = raw_value * scaling + offset". * **scaling** *(float) --* A multiplier used to decode the message. * **upperBound** *(integer) --* An optional attribute specifying the upper bound for "STRING" and "WSTRING". * **structuredMessageListDefinition** *(dict) --* Represents a list type node of the complex data structure. * **name** *(string) --* **[REQUIRED]** The name of the structured message list definition. * **memberType** *(dict) --* The member type of the structured message list definition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". * **listType** *(string) --* **[REQUIRED]** The type of list of the structured message list definition. * **capacity** *(integer) --* The capacity of the structured message list definition when the list type is "FIXED_CAPACITY" or "DYNAMIC_BOUNDED_CAPACITY". * **structuredMessageDefinition** *(list) --* Represents a struct type node of the complex data structure. * *(dict) --* Represents a "StructureMessageName" to "DataType" map element. * **fieldName** *(string) --* **[REQUIRED]** The field name of the structured message. It determines how a data value is referenced in the target language. * **dataType** *(dict) --* The data type. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". * **customDecodingSignal** *(dict) --* Information about a custom signal decoder. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **id** *(string) --* **[REQUIRED]** The ID of the signal. * **signalDecodersToRemove** (*list*) -- A list of signal decoders to remove from the decoder manifest. * *(string) --* * **networkInterfacesToAdd** (*list*) -- A list of information about the network interfaces to add to the decoder manifest. * *(dict) --* Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node. To return this information about all the network interfaces specified in a decoder manifest, use the API operation. * **interfaceId** *(string) --* **[REQUIRED]** The ID of the network interface. * **type** *(string) --* **[REQUIRED]** The network protocol for the vehicle. For example, "CAN_SIGNAL" specifies a protocol that defines how data is communicated between electronic control units (ECUs). "OBD_SIGNAL" specifies a protocol that defines how self- diagnostic data is communicated between ECUs. * **canInterface** *(dict) --* Information about a network interface specified by the Controller Area Network (CAN) protocol. * **name** *(string) --* **[REQUIRED]** The unique name of the interface. * **protocolName** *(string) --* The name of the communication protocol for the interface. * **protocolVersion** *(string) --* The version of the communication protocol for the interface. * **obdInterface** *(dict) --* Information about a network interface specified by the on- board diagnostic (OBD) II protocol. * **name** *(string) --* **[REQUIRED]** The name of the interface. * **requestMessageId** *(integer) --* **[REQUIRED]** The ID of the message requesting vehicle data. * **obdStandard** *(string) --* The standard OBD II PID. * **pidRequestIntervalSeconds** *(integer) --* The maximum number message requests per second. * **dtcRequestIntervalSeconds** *(integer) --* The maximum number message requests per diagnostic trouble code per second. * **useExtendedIds** *(boolean) --* Whether to use extended IDs in the message. * **hasTransmissionEcu** *(boolean) --* Whether the vehicle has a transmission control module (TCM). * **vehicleMiddleware** *(dict) --* The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include "ROS2" and "SOME/IP". * **name** *(string) --* **[REQUIRED]** The name of the vehicle middleware. * **protocolName** *(string) --* **[REQUIRED]** The protocol name of the vehicle middleware. * **customDecodingInterface** *(dict) --* Information about a custom network interface. * **name** *(string) --* **[REQUIRED]** The name of the interface. * **networkInterfacesToUpdate** (*list*) -- A list of information about the network interfaces to update in the decoder manifest. * *(dict) --* Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node. To return this information about all the network interfaces specified in a decoder manifest, use the API operation. * **interfaceId** *(string) --* **[REQUIRED]** The ID of the network interface. * **type** *(string) --* **[REQUIRED]** The network protocol for the vehicle. For example, "CAN_SIGNAL" specifies a protocol that defines how data is communicated between electronic control units (ECUs). "OBD_SIGNAL" specifies a protocol that defines how self- diagnostic data is communicated between ECUs. * **canInterface** *(dict) --* Information about a network interface specified by the Controller Area Network (CAN) protocol. * **name** *(string) --* **[REQUIRED]** The unique name of the interface. * **protocolName** *(string) --* The name of the communication protocol for the interface. * **protocolVersion** *(string) --* The version of the communication protocol for the interface. * **obdInterface** *(dict) --* Information about a network interface specified by the on- board diagnostic (OBD) II protocol. * **name** *(string) --* **[REQUIRED]** The name of the interface. * **requestMessageId** *(integer) --* **[REQUIRED]** The ID of the message requesting vehicle data. * **obdStandard** *(string) --* The standard OBD II PID. * **pidRequestIntervalSeconds** *(integer) --* The maximum number message requests per second. * **dtcRequestIntervalSeconds** *(integer) --* The maximum number message requests per diagnostic trouble code per second. * **useExtendedIds** *(boolean) --* Whether to use extended IDs in the message. * **hasTransmissionEcu** *(boolean) --* Whether the vehicle has a transmission control module (TCM). * **vehicleMiddleware** *(dict) --* The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include "ROS2" and "SOME/IP". * **name** *(string) --* **[REQUIRED]** The name of the vehicle middleware. * **protocolName** *(string) --* **[REQUIRED]** The protocol name of the vehicle middleware. * **customDecodingInterface** *(dict) --* Information about a custom network interface. * **name** *(string) --* **[REQUIRED]** The name of the interface. * **networkInterfacesToRemove** (*list*) -- A list of network interfaces to remove from the decoder manifest. * *(string) --* * **status** (*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. * **defaultForUnmappedSignals** (*string*) -- Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.DecoderManifestValidationExcepti on" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / create_decoder_manifest create_decoder_manifest *********************** IoTFleetWise.Client.create_decoder_manifest(**kwargs) 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** response = client.create_decoder_manifest( name='string', description='string', modelManifestArn='string', signalDecoders=[ { 'fullyQualifiedName': 'string', 'type': 'CAN_SIGNAL'|'OBD_SIGNAL'|'MESSAGE_SIGNAL'|'CUSTOM_DECODING_SIGNAL', 'interfaceId': 'string', 'canSignal': { 'messageId': 123, 'isBigEndian': True|False, 'isSigned': True|False, 'startBit': 123, 'offset': 123.0, 'factor': 123.0, 'length': 123, 'name': 'string', 'signalValueType': 'INTEGER'|'FLOATING_POINT' }, 'obdSignal': { 'pidResponseLength': 123, 'serviceMode': 123, 'pid': 123, 'scaling': 123.0, 'offset': 123.0, 'startByte': 123, 'byteLength': 123, 'bitRightShift': 123, 'bitMaskLength': 123, 'isSigned': True|False, 'signalValueType': 'INTEGER'|'FLOATING_POINT' }, 'messageSignal': { 'topicName': 'string', 'structuredMessage': { 'primitiveMessageDefinition': { 'ros2PrimitiveMessageDefinition': { 'primitiveType': 'BOOL'|'BYTE'|'CHAR'|'FLOAT32'|'FLOAT64'|'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'STRING'|'WSTRING', 'offset': 123.0, 'scaling': 123.0, 'upperBound': 123 } }, 'structuredMessageListDefinition': { 'name': 'string', 'memberType': {'... recursive ...'}, 'listType': 'FIXED_CAPACITY'|'DYNAMIC_UNBOUNDED_CAPACITY'|'DYNAMIC_BOUNDED_CAPACITY', 'capacity': 123 }, 'structuredMessageDefinition': [ { 'fieldName': 'string', 'dataType': {'... recursive ...'} }, ] } }, 'customDecodingSignal': { 'id': 'string' } }, ], networkInterfaces=[ { 'interfaceId': 'string', 'type': 'CAN_INTERFACE'|'OBD_INTERFACE'|'VEHICLE_MIDDLEWARE'|'CUSTOM_DECODING_INTERFACE', 'canInterface': { 'name': 'string', 'protocolName': 'string', 'protocolVersion': 'string' }, 'obdInterface': { 'name': 'string', 'requestMessageId': 123, 'obdStandard': 'string', 'pidRequestIntervalSeconds': 123, 'dtcRequestIntervalSeconds': 123, 'useExtendedIds': True|False, 'hasTransmissionEcu': True|False }, 'vehicleMiddleware': { 'name': 'string', 'protocolName': 'ROS_2' }, 'customDecodingInterface': { 'name': 'string' } }, ], defaultForUnmappedSignals='CUSTOM_DECODING', tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **name** (*string*) -- **[REQUIRED]** The unique name of the decoder manifest to create. * **description** (*string*) -- A brief description of the decoder manifest. * **modelManifestArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the vehicle model (model manifest). * **signalDecoders** (*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]** Determines whether the message is signed ( "true") or not ( "false"). If it's signed, the message can represent both positive and negative numbers. The "isSigned" parameter only applies to the "INTEGER" raw signal type, and it doesn't affect the "FLOATING_POINT" raw signal type. * **startBit** *(integer) --* **[REQUIRED]** Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB). This value might be different from the value in a DBC file. For little endian signals, "startBit" is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the "startBit". * **offset** *(float) --* **[REQUIRED]** The offset used to calculate the signal value. Combined with factor, the calculation is "value = raw_value * factor + offset". * **factor** *(float) --* **[REQUIRED]** A multiplier used to decode the CAN message. * **length** *(integer) --* **[REQUIRED]** How many bytes of data are in the message. * **name** *(string) --* The name of the signal. * **signalValueType** *(string) --* The value type of the signal. The default value is "INTEGER". * **obdSignal** *(dict) --* Information about signal decoder using the on-board diagnostic (OBD) II protocol. * **pidResponseLength** *(integer) --* **[REQUIRED]** The length of the requested data. * **serviceMode** *(integer) --* **[REQUIRED]** The mode of operation (diagnostic service) in a message. * **pid** *(integer) --* **[REQUIRED]** The diagnostic code used to request data from a vehicle for this signal. * **scaling** *(float) --* **[REQUIRED]** A multiplier used to decode the message. * **offset** *(float) --* **[REQUIRED]** The offset used to calculate the signal value. Combined with scaling, the calculation is "value = raw_value * scaling + offset". * **startByte** *(integer) --* **[REQUIRED]** Indicates the beginning of the message. * **byteLength** *(integer) --* **[REQUIRED]** The length of a message. * **bitRightShift** *(integer) --* The number of positions to shift bits in the message. * **bitMaskLength** *(integer) --* The number of bits to mask in a message. * **isSigned** *(boolean) --* Determines whether the message is signed ( "true") or not ( "false"). If it's signed, the message can represent both positive and negative numbers. The "isSigned" parameter only applies to the "INTEGER" raw signal type, and it doesn't affect the "FLOATING_POINT" raw signal type. The default value is "false". * **signalValueType** *(string) --* The value type of the signal. The default value is "INTEGER". * **messageSignal** *(dict) --* The decoding information for a specific message which supports higher order data types. * **topicName** *(string) --* **[REQUIRED]** The topic name for the message signal. It corresponds to topics in ROS 2. * **structuredMessage** *(dict) --* **[REQUIRED]** The structured message for the message signal. It can be defined with either a "primitiveMessageDefinition", "structuredMessageListDefinition", or "structuredMessageDefinition" recursively. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". * **primitiveMessageDefinition** *(dict) --* Represents a primitive type node of the complex data structure. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "ros2PrimitiveMessageDefinition". * **ros2PrimitiveMessageDefinition** *(dict) --* Information about a "PrimitiveMessage" using a ROS 2 compliant primitive type message of the complex data structure. * **primitiveType** *(string) --* **[REQUIRED]** The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition. * **offset** *(float) --* The offset used to calculate the signal value. Combined with scaling, the calculation is "value = raw_value * scaling + offset". * **scaling** *(float) --* A multiplier used to decode the message. * **upperBound** *(integer) --* An optional attribute specifying the upper bound for "STRING" and "WSTRING". * **structuredMessageListDefinition** *(dict) --* Represents a list type node of the complex data structure. * **name** *(string) --* **[REQUIRED]** The name of the structured message list definition. * **memberType** *(dict) --* The member type of the structured message list definition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". * **listType** *(string) --* **[REQUIRED]** The type of list of the structured message list definition. * **capacity** *(integer) --* The capacity of the structured message list definition when the list type is "FIXED_CAPACITY" or "DYNAMIC_BOUNDED_CAPACITY". * **structuredMessageDefinition** *(list) --* Represents a struct type node of the complex data structure. * *(dict) --* Represents a "StructureMessageName" to "DataType" map element. * **fieldName** *(string) --* **[REQUIRED]** The field name of the structured message. It determines how a data value is referenced in the target language. * **dataType** *(dict) --* The data type. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". * **customDecodingSignal** *(dict) --* Information about a custom signal decoder. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **id** *(string) --* **[REQUIRED]** The ID of the signal. * **networkInterfaces** (*list*) -- A list of information about available network interfaces. * *(dict) --* Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node. To return this information about all the network interfaces specified in a decoder manifest, use the API operation. * **interfaceId** *(string) --* **[REQUIRED]** The ID of the network interface. * **type** *(string) --* **[REQUIRED]** The network protocol for the vehicle. For example, "CAN_SIGNAL" specifies a protocol that defines how data is communicated between electronic control units (ECUs). "OBD_SIGNAL" specifies a protocol that defines how self- diagnostic data is communicated between ECUs. * **canInterface** *(dict) --* Information about a network interface specified by the Controller Area Network (CAN) protocol. * **name** *(string) --* **[REQUIRED]** The unique name of the interface. * **protocolName** *(string) --* The name of the communication protocol for the interface. * **protocolVersion** *(string) --* The version of the communication protocol for the interface. * **obdInterface** *(dict) --* Information about a network interface specified by the on- board diagnostic (OBD) II protocol. * **name** *(string) --* **[REQUIRED]** The name of the interface. * **requestMessageId** *(integer) --* **[REQUIRED]** The ID of the message requesting vehicle data. * **obdStandard** *(string) --* The standard OBD II PID. * **pidRequestIntervalSeconds** *(integer) --* The maximum number message requests per second. * **dtcRequestIntervalSeconds** *(integer) --* The maximum number message requests per diagnostic trouble code per second. * **useExtendedIds** *(boolean) --* Whether to use extended IDs in the message. * **hasTransmissionEcu** *(boolean) --* Whether the vehicle has a transmission control module (TCM). * **vehicleMiddleware** *(dict) --* The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include "ROS2" and "SOME/IP". * **name** *(string) --* **[REQUIRED]** The name of the vehicle middleware. * **protocolName** *(string) --* **[REQUIRED]** The protocol name of the vehicle middleware. * **customDecodingInterface** *(dict) --* Information about a custom network interface. * **name** *(string) --* **[REQUIRED]** The name of the interface. * **defaultForUnmappedSignals** (*string*) -- Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **tags** (*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. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.DecoderManifestValidationExcepti on" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / get_paginator get_paginator ************* IoTFleetWise.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. IoTFleetWise / Client / list_decoder_manifests list_decoder_manifests ********************** IoTFleetWise.Client.list_decoder_manifests(**kwargs) 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** response = client.list_decoder_manifests( modelManifestArn='string', nextToken='string', maxResults=123, listResponseScope='METADATA_ONLY' ) Parameters: * **modelManifestArn** (*string*) -- The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest. * **nextToken** (*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. * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. * **listResponseScope** (*string*) -- When you set the "listResponseScope" parameter to "METADATA_ONLY", the list response includes: decoder manifest name, Amazon Resource Name (ARN), creation time, and last modification time. Return type: dict Returns: **Response Syntax** { 'summaries': [ { 'name': 'string', 'arn': 'string', 'modelManifestArn': 'string', 'description': 'string', 'status': 'ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING', 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1), 'message': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **summaries** *(list) --* A list of information about each decoder manifest. * *(dict) --* Information about a created decoder manifest. You can use the API operation to return this information about multiple decoder manifests. * **name** *(string) --* The name of the decoder manifest. * **arn** *(string) --* The ARN of a vehicle model (model manifest) associated with the decoder manifest. * **modelManifestArn** *(string) --* The ARN of a vehicle model (model manifest) associated with the decoder manifest. * **description** *(string) --* A brief description of the decoder manifest. * **status** *(string) --* The state of the decoder manifest. If the status is "ACTIVE", the decoder manifest can't be edited. If the status is marked "DRAFT", you can edit the decoder manifest. * **creationTime** *(datetime) --* The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time). * **lastModificationTime** *(datetime) --* The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). * **message** *(string) --* The detailed message for the decoder manifest. When a decoder manifest is in an "INVALID" status, the message contains detailed reason and help information. * **nextToken** *(string) --* The token to retrieve the next set of results, or "null" if there are no more results. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / list_vehicles_in_fleet list_vehicles_in_fleet ********************** IoTFleetWise.Client.list_vehicles_in_fleet(**kwargs) 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** response = client.list_vehicles_in_fleet( fleetId='string', nextToken='string', maxResults=123 ) Parameters: * **fleetId** (*string*) -- **[REQUIRED]** The ID of a fleet. * **nextToken** (*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. * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / update_signal_catalog update_signal_catalog ********************* IoTFleetWise.Client.update_signal_catalog(**kwargs) Updates a signal catalog. See also: AWS API Documentation **Request Syntax** response = client.update_signal_catalog( name='string', description='string', nodesToAdd=[ { 'branch': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'sensor': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'actuator': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'attribute': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'defaultValue': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'struct': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'property': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'dataEncoding': 'BINARY'|'TYPED', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' } }, ], nodesToUpdate=[ { 'branch': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'sensor': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'actuator': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'attribute': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'defaultValue': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'struct': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'property': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'dataEncoding': 'BINARY'|'TYPED', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' } }, ], nodesToRemove=[ 'string', ] ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the signal catalog to update. * **description** (*string*) -- A brief description of the signal catalog to update. * **nodesToAdd** (*list*) -- A list of information about nodes to add to the signal catalog. * *(dict) --* A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "branch", "sensor", "actuator", "attribute", "struct", "property". * **branch** *(dict) --* Information about a node specified as a branch. Note: A group of signals that are defined in a hierarchical structure. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the branch. For example, the fully qualified name of a branch might be "Vehicle.Body.Engine". * **description** *(string) --* A brief description of the branch. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **sensor** *(dict) --* An input component that reports the environmental condition of a vehicle. Note: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be "Vehicle.Body.Engine.Battery". * **dataType** *(string) --* **[REQUIRED]** The specified data type of the sensor. * **description** *(string) --* A brief description of a sensor. * **unit** *(string) --* The scientific unit of measurement for data collected by the sensor. * **allowedValues** *(list) --* A list of possible values a sensor can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of the sensor. * **max** *(float) --* The specified possible maximum value of the sensor. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for a sensor if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of a sensor might be "Vehicle.ADAS.CameraStruct". * **actuator** *(dict) --* Information about a node specified as an actuator. Note: An actuator is a digital representation of a vehicle device. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be "Vehicle.Front.Left.Door.Lock". * **dataType** *(string) --* **[REQUIRED]** The specified data type of the actuator. * **description** *(string) --* A brief description of the actuator. * **unit** *(string) --* The scientific unit for the actuator. * **allowedValues** *(list) --* A list of possible values an actuator can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of an actuator. * **max** *(float) --* The specified possible maximum value of an actuator. * **assignedValue** *(string) --* A specified value for the actuator. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the actuator if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of an actuator might be "Vehicle.Door.LockStruct". * **attribute** *(dict) --* Information about a node specified as an attribute. Note: An attribute represents static information about a vehicle. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be "Vehicle.Body.Engine.Type". * **dataType** *(string) --* **[REQUIRED]** The specified data type of the attribute. * **description** *(string) --* A brief description of the attribute. * **unit** *(string) --* The scientific unit for the attribute. * **allowedValues** *(list) --* A list of possible values an attribute can be assigned. * *(string) --* * **min** *(float) --* The specified possible minimum value of the attribute. * **max** *(float) --* The specified possible maximum value of the attribute. * **assignedValue** *(string) --* A specified value for the attribute. * **defaultValue** *(string) --* The default value of the attribute. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **struct** *(dict) --* Represents a complex or higher-order data structure. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be "ComplexDataTypes.VehicleDataTypes.SVMCamera". * **description** *(string) --* A brief description of the custom structure. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **property** *(dict) --* Represents a member of the complex data structure. The "datatype" of the property can be either primitive or another "struct". * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be "ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS". * **dataType** *(string) --* **[REQUIRED]** The data type for the custom property. * **dataEncoding** *(string) --* Indicates whether the property is binary data. * **description** *(string) --* A brief description of the custom property. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the custom property if the data type of the custom property is "Struct" or "StructArray". * **nodesToUpdate** (*list*) -- A list of information about nodes to update in the signal catalog. * *(dict) --* A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "branch", "sensor", "actuator", "attribute", "struct", "property". * **branch** *(dict) --* Information about a node specified as a branch. Note: A group of signals that are defined in a hierarchical structure. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the branch. For example, the fully qualified name of a branch might be "Vehicle.Body.Engine". * **description** *(string) --* A brief description of the branch. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **sensor** *(dict) --* An input component that reports the environmental condition of a vehicle. Note: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be "Vehicle.Body.Engine.Battery". * **dataType** *(string) --* **[REQUIRED]** The specified data type of the sensor. * **description** *(string) --* A brief description of a sensor. * **unit** *(string) --* The scientific unit of measurement for data collected by the sensor. * **allowedValues** *(list) --* A list of possible values a sensor can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of the sensor. * **max** *(float) --* The specified possible maximum value of the sensor. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for a sensor if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of a sensor might be "Vehicle.ADAS.CameraStruct". * **actuator** *(dict) --* Information about a node specified as an actuator. Note: An actuator is a digital representation of a vehicle device. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be "Vehicle.Front.Left.Door.Lock". * **dataType** *(string) --* **[REQUIRED]** The specified data type of the actuator. * **description** *(string) --* A brief description of the actuator. * **unit** *(string) --* The scientific unit for the actuator. * **allowedValues** *(list) --* A list of possible values an actuator can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of an actuator. * **max** *(float) --* The specified possible maximum value of an actuator. * **assignedValue** *(string) --* A specified value for the actuator. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the actuator if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of an actuator might be "Vehicle.Door.LockStruct". * **attribute** *(dict) --* Information about a node specified as an attribute. Note: An attribute represents static information about a vehicle. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be "Vehicle.Body.Engine.Type". * **dataType** *(string) --* **[REQUIRED]** The specified data type of the attribute. * **description** *(string) --* A brief description of the attribute. * **unit** *(string) --* The scientific unit for the attribute. * **allowedValues** *(list) --* A list of possible values an attribute can be assigned. * *(string) --* * **min** *(float) --* The specified possible minimum value of the attribute. * **max** *(float) --* The specified possible maximum value of the attribute. * **assignedValue** *(string) --* A specified value for the attribute. * **defaultValue** *(string) --* The default value of the attribute. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **struct** *(dict) --* Represents a complex or higher-order data structure. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be "ComplexDataTypes.VehicleDataTypes.SVMCamera". * **description** *(string) --* A brief description of the custom structure. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **property** *(dict) --* Represents a member of the complex data structure. The "datatype" of the property can be either primitive or another "struct". * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be "ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS". * **dataType** *(string) --* **[REQUIRED]** The data type for the custom property. * **dataEncoding** *(string) --* Indicates whether the property is binary data. * **description** *(string) --* A brief description of the custom property. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the custom property if the data type of the custom property is "Struct" or "StructArray". * **nodesToRemove** (*list*) -- A list of "fullyQualifiedName" of nodes to remove from the signal catalog. * *(string) --* Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.InvalidNodeException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.InvalidSignalsException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / can_paginate can_paginate ************ IoTFleetWise.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. IoTFleetWise / Client / update_state_template update_state_template ********************* IoTFleetWise.Client.update_state_template(**kwargs) Updates a state template. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.update_state_template( identifier='string', description='string', stateTemplatePropertiesToAdd=[ 'string', ], stateTemplatePropertiesToRemove=[ 'string', ], dataExtraDimensions=[ 'string', ], metadataExtraDimensions=[ 'string', ] ) Parameters: * **identifier** (*string*) -- **[REQUIRED]** The unique ID of the state template. * **description** (*string*) -- A brief description of the state template. * **stateTemplatePropertiesToAdd** (*list*) -- Add signals from which data is collected as part of the state template. * *(string) --* * **stateTemplatePropertiesToRemove** (*list*) -- Remove signals from which data is collected as part of the state template. * *(string) --* * **dataExtraDimensions** (*list*) -- A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add "Vehicle.Attributes.Make" and "Vehicle.Attributes.Model" attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the "extraDimensions" field. Default: An empty array * *(string) --* * **metadataExtraDimensions** (*list*) -- A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add "Vehicle.Attributes.Make" and "Vehicle.Attributes.Model" attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message. * *(string) --* Return type: dict Returns: **Response Syntax** { 'name': 'string', 'arn': 'string', 'id': 'string' } **Response Structure** * *(dict) --* * **name** *(string) --* The name of the state template. * **arn** *(string) --* The Amazon Resource Name (ARN) of the state template. * **id** *(string) --* The unique ID of the state template. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.InvalidSignalsException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / get_vehicle_status get_vehicle_status ****************** IoTFleetWise.Client.get_vehicle_status(**kwargs) Retrieves information about the status of campaigns, decoder manifests, or state templates associated with a vehicle. See also: AWS API Documentation **Request Syntax** response = client.get_vehicle_status( nextToken='string', maxResults=123, vehicleName='string' ) Parameters: * **nextToken** (*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. This parameter is only supported for resources of type "CAMPAIGN". * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. This parameter is only supported for resources of type "CAMPAIGN". * **vehicleName** (*string*) -- **[REQUIRED]** The ID of the vehicle to retrieve information about. Return type: dict Returns: **Response Syntax** { 'campaigns': [ { 'campaignName': 'string', 'vehicleName': 'string', 'status': 'CREATED'|'READY'|'HEALTHY'|'SUSPENDED'|'DELETING'|'READY_FOR_CHECKIN' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **campaigns** *(list) --* Lists information about the state of the vehicle with deployed campaigns. * *(dict) --* Information about a campaign associated with a vehicle. * **campaignName** *(string) --* The name of a campaign. * **vehicleName** *(string) --* The unique ID of the vehicle. * **status** *(string) --* The status of a campaign, which can be one of the following: * "CREATED" - The campaign exists but is not yet approved. * "READY" - The campaign is approved but has not been deployed to the vehicle. Data has not arrived at the vehicle yet. * "HEALTHY" - The campaign is deployed to the vehicle. * "SUSPENDED" - The campaign is suspended and data collection is paused. * "DELETING" - The campaign is being removed from the vehicle. * "READY_FOR_CHECKIN" - The campaign is approved and waiting for vehicle check-in before deployment. * **nextToken** *(string) --* The token to retrieve the next set of results, or "null" if there are no more results. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / list_decoder_manifest_signals list_decoder_manifest_signals ***************************** IoTFleetWise.Client.list_decoder_manifest_signals(**kwargs) 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** response = client.list_decoder_manifest_signals( name='string', nextToken='string', maxResults=123 ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the decoder manifest to list information about. * **nextToken** (*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. * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. Return type: dict Returns: **Response Syntax** { 'signalDecoders': [ { 'fullyQualifiedName': 'string', 'type': 'CAN_SIGNAL'|'OBD_SIGNAL'|'MESSAGE_SIGNAL'|'CUSTOM_DECODING_SIGNAL', 'interfaceId': 'string', 'canSignal': { 'messageId': 123, 'isBigEndian': True|False, 'isSigned': True|False, 'startBit': 123, 'offset': 123.0, 'factor': 123.0, 'length': 123, 'name': 'string', 'signalValueType': 'INTEGER'|'FLOATING_POINT' }, 'obdSignal': { 'pidResponseLength': 123, 'serviceMode': 123, 'pid': 123, 'scaling': 123.0, 'offset': 123.0, 'startByte': 123, 'byteLength': 123, 'bitRightShift': 123, 'bitMaskLength': 123, 'isSigned': True|False, 'signalValueType': 'INTEGER'|'FLOATING_POINT' }, 'messageSignal': { 'topicName': 'string', 'structuredMessage': { 'primitiveMessageDefinition': { 'ros2PrimitiveMessageDefinition': { 'primitiveType': 'BOOL'|'BYTE'|'CHAR'|'FLOAT32'|'FLOAT64'|'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'STRING'|'WSTRING', 'offset': 123.0, 'scaling': 123.0, 'upperBound': 123 } }, 'structuredMessageListDefinition': { 'name': 'string', 'memberType': {'... recursive ...'}, 'listType': 'FIXED_CAPACITY'|'DYNAMIC_UNBOUNDED_CAPACITY'|'DYNAMIC_BOUNDED_CAPACITY', 'capacity': 123 }, 'structuredMessageDefinition': [ { 'fieldName': 'string', 'dataType': {'... recursive ...'} }, ] } }, 'customDecodingSignal': { 'id': 'string' } }, ], '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) --* Determines whether the message is signed ( "true") or not ( "false"). If it's signed, the message can represent both positive and negative numbers. The "isSigned" parameter only applies to the "INTEGER" raw signal type, and it doesn't affect the "FLOATING_POINT" raw signal type. * **startBit** *(integer) --* Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB). This value might be different from the value in a DBC file. For little endian signals, "startBit" is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the "startBit". * **offset** *(float) --* The offset used to calculate the signal value. Combined with factor, the calculation is "value = raw_value * factor + offset". * **factor** *(float) --* A multiplier used to decode the CAN message. * **length** *(integer) --* How many bytes of data are in the message. * **name** *(string) --* The name of the signal. * **signalValueType** *(string) --* The value type of the signal. The default value is "INTEGER". * **obdSignal** *(dict) --* Information about signal decoder using the on-board diagnostic (OBD) II protocol. * **pidResponseLength** *(integer) --* The length of the requested data. * **serviceMode** *(integer) --* The mode of operation (diagnostic service) in a message. * **pid** *(integer) --* The diagnostic code used to request data from a vehicle for this signal. * **scaling** *(float) --* A multiplier used to decode the message. * **offset** *(float) --* The offset used to calculate the signal value. Combined with scaling, the calculation is "value = raw_value * scaling + offset". * **startByte** *(integer) --* Indicates the beginning of the message. * **byteLength** *(integer) --* The length of a message. * **bitRightShift** *(integer) --* The number of positions to shift bits in the message. * **bitMaskLength** *(integer) --* The number of bits to mask in a message. * **isSigned** *(boolean) --* Determines whether the message is signed ( "true") or not ( "false"). If it's signed, the message can represent both positive and negative numbers. The "isSigned" parameter only applies to the "INTEGER" raw signal type, and it doesn't affect the "FLOATING_POINT" raw signal type. The default value is "false". * **signalValueType** *(string) --* The value type of the signal. The default value is "INTEGER". * **messageSignal** *(dict) --* The decoding information for a specific message which supports higher order data types. * **topicName** *(string) --* The topic name for the message signal. It corresponds to topics in ROS 2. * **structuredMessage** *(dict) --* The structured message for the message signal. It can be defined with either a "primitiveMessageDefinition", "structuredMessageListDefinition", or "structuredMessageDefinition" recursively. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **primitiveMessageDefinition** *(dict) --* Represents a primitive type node of the complex data structure. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "ros2PrimitiveMessageDefinition". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **ros2PrimitiveMessageDefinition** *(dict) --* Information about a "PrimitiveMessage" using a ROS 2 compliant primitive type message of the complex data structure. * **primitiveType** *(string) --* The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition. * **offset** *(float) --* The offset used to calculate the signal value. Combined with scaling, the calculation is "value = raw_value * scaling + offset". * **scaling** *(float) --* A multiplier used to decode the message. * **upperBound** *(integer) --* An optional attribute specifying the upper bound for "STRING" and "WSTRING". * **structuredMessageListDefinition** *(dict) --* Represents a list type node of the complex data structure. * **name** *(string) --* The name of the structured message list definition. * **memberType** *(dict) --* The member type of the structured message list definition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **listType** *(string) --* The type of list of the structured message list definition. * **capacity** *(integer) --* The capacity of the structured message list definition when the list type is "FIXED_CAPACITY" or "DYNAMIC_BOUNDED_CAPACITY". * **structuredMessageDefinition** *(list) --* Represents a struct type node of the complex data structure. * *(dict) --* Represents a "StructureMessageName" to "DataType" map element. * **fieldName** *(string) --* The field name of the structured message. It determines how a data value is referenced in the target language. * **dataType** *(dict) --* The data type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "primitiveMessageDefinition", "structuredMessageListDefinition", "structuredMessageDefinition". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **customDecodingSignal** *(dict) --* Information about a custom signal decoder. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **id** *(string) --* The ID of the signal. * **nextToken** *(string) --* The token to retrieve the next set of results, or "null" if there are no more results. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / get_register_account_status get_register_account_status *************************** IoTFleetWise.Client.get_register_account_status() 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** response = client.get_register_account_status() Return type: dict Returns: **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). **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / list_signal_catalogs list_signal_catalogs ******************** IoTFleetWise.Client.list_signal_catalogs(**kwargs) 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** response = client.list_signal_catalogs( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*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. * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / get_vehicle get_vehicle *********** IoTFleetWise.Client.get_vehicle(**kwargs) Retrieves information about a vehicle. See also: AWS API Documentation **Request Syntax** response = client.get_vehicle( vehicleName='string' ) Parameters: **vehicleName** (*string*) -- **[REQUIRED]** The ID of the vehicle to retrieve information about. Return type: dict Returns: **Response Syntax** { 'vehicleName': 'string', 'arn': 'string', 'modelManifestArn': 'string', 'decoderManifestArn': 'string', 'attributes': { 'string': 'string' }, 'stateTemplates': [ { 'identifier': 'string', 'stateTemplateUpdateStrategy': { 'periodic': { 'stateTemplateUpdateRate': { 'unit': 'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR', 'value': 123 } }, 'onChange': {} } }, ], '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) --* * **stateTemplates** *(list) --* State templates associated with the vehicle. * *(dict) --* The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **identifier** *(string) --* The unique ID of the state template. * **stateTemplateUpdateStrategy** *(dict) --* The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an "onChange" or "periodic" update strategy. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "periodic", "onChange". 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'} * **periodic** *(dict) --* Vehicles associated with the state template will stream telemetry data during a specified time period. * **stateTemplateUpdateRate** *(dict) --* The length of time between state template updates. * **unit** *(string) --* A unit of time. * **value** *(integer) --* A number of time units. * **onChange** *(dict) --* Vehicles associated with the state template will stream telemetry data when there is a change. * **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). **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / put_encryption_configuration put_encryption_configuration **************************** IoTFleetWise.Client.put_encryption_configuration(**kwargs) Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryption in the *Amazon Web Services IoT FleetWise Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.put_encryption_configuration( kmsKeyId='string', encryptionType='KMS_BASED_ENCRYPTION'|'FLEETWISE_DEFAULT_ENCRYPTION' ) Parameters: * **kmsKeyId** (*string*) -- The ID of the KMS key that is used for encryption. * **encryptionType** (*string*) -- **[REQUIRED]** The type of encryption. Choose "KMS_BASED_ENCRYPTION" to use a KMS key or "FLEETWISE_DEFAULT_ENCRYPTION" to use an Amazon Web Services managed key. Return type: dict Returns: **Response Syntax** { 'kmsKeyId': 'string', 'encryptionStatus': 'PENDING'|'SUCCESS'|'FAILURE', 'encryptionType': 'KMS_BASED_ENCRYPTION'|'FLEETWISE_DEFAULT_ENCRYPTION' } **Response Structure** * *(dict) --* * **kmsKeyId** *(string) --* The ID of the KMS key that is used for encryption. * **encryptionStatus** *(string) --* The encryption status. * **encryptionType** *(string) --* The type of encryption. Set to "KMS_BASED_ENCRYPTION" to use an KMS key that you own and manage. Set to "FLEETWISE_DEFAULT_ENCRYPTION" to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / update_campaign update_campaign *************** IoTFleetWise.Client.update_campaign(**kwargs) Updates a campaign. See also: AWS API Documentation **Request Syntax** response = client.update_campaign( name='string', description='string', dataExtraDimensions=[ 'string', ], action='APPROVE'|'SUSPEND'|'RESUME'|'UPDATE' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the campaign to update. * **description** (*string*) -- The description of the campaign. * **dataExtraDimensions** (*list*) -- A list of vehicle attributes to associate with a signal. Default: An empty array * *(string) --* * **action** (*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. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data. * "RESUME" - To reactivate the "SUSPEND" campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data. * "UPDATE" - To update a campaign. Return type: dict Returns: **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 you create a campaign, it enters this state. Use the API operation to approve the campaign for deployment to the target vehicle or fleet. * "RUNNING" - The campaign is active. * "SUSPENDED" - The campaign is suspended. To resume the campaign, use the API operation. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / list_vehicles list_vehicles ************* IoTFleetWise.Client.list_vehicles(**kwargs) 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** response = client.list_vehicles( modelManifestArn='string', attributeNames=[ 'string', ], attributeValues=[ 'string', ], nextToken='string', maxResults=123, listResponseScope='METADATA_ONLY' ) Parameters: * **modelManifestArn** (*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. * **attributeNames** (*list*) -- The fully qualified names of the attributes. You can use this optional parameter to list the vehicles containing all the attributes in the request. For example, "attributeNames" could be " "Vehicle.Body.Engine.Type, Vehicle.Color"" and the corresponding "attributeValues" could be " "1.3 L R2, Blue"" . In this case, the API will filter vehicles with an attribute name "Vehicle.Body.Engine.Type" that contains a value of "1.3 L R2" AND an attribute name "Vehicle.Color" that contains a value of " "Blue"". A request must contain unique values for the "attributeNames" filter and the matching number of "attributeValues" filters to return the subset of vehicles that match the attributes filter condition. * *(string) --* * **attributeValues** (*list*) -- Static information about a vehicle attribute value in string format. You can use this optional parameter in conjunction with "attributeNames" to list the vehicles containing all the "attributeValues" corresponding to the "attributeNames" filter. For example, "attributeValues" could be " "1.3 L R2, Blue"" and the corresponding "attributeNames" filter could be " "Vehicle.Body.Engine.Type, Vehicle.Color"". In this case, the API will filter vehicles with attribute name "Vehicle.Body.Engine.Type" that contains a value of "1.3 L R2" AND an attribute name "Vehicle.Color" that contains a value of " "Blue"". A request must contain unique values for the "attributeNames" filter and the matching number of "attributeValues" filter to return the subset of vehicles that match the attributes filter condition. * *(string) --* * **nextToken** (*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. * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. * **listResponseScope** (*string*) -- When you set the "listResponseScope" parameter to "METADATA_ONLY", the list response includes: vehicle name, Amazon Resource Name (ARN), creation time, and last modification time. Return type: dict Returns: **Response Syntax** { 'vehicleSummaries': [ { 'vehicleName': 'string', 'arn': 'string', 'modelManifestArn': 'string', 'decoderManifestArn': 'string', 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1), 'attributes': { 'string': 'string' } }, ], '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). * **attributes** *(dict) --* Static information about a vehicle in a key-value pair. For example: ""engineType"" : ""1.3 L R2"" * *(string) --* * *(string) --* * **nextToken** *(string) --* The token to retrieve the next set of results, or "null" if there are no more results. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / get_state_template get_state_template ****************** IoTFleetWise.Client.get_state_template(**kwargs) Retrieves information about a state template. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_state_template( identifier='string' ) Parameters: **identifier** (*string*) -- **[REQUIRED]** The unique ID of the state template. Return type: dict Returns: **Response Syntax** { 'name': 'string', 'arn': 'string', 'description': 'string', 'signalCatalogArn': 'string', 'stateTemplateProperties': [ 'string', ], 'dataExtraDimensions': [ 'string', ], 'metadataExtraDimensions': [ 'string', ], 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1), 'id': 'string' } **Response Structure** * *(dict) --* * **name** *(string) --* The name of the state template. * **arn** *(string) --* The Amazon Resource Name (ARN) of the state template. * **description** *(string) --* A brief description of the state template. * **signalCatalogArn** *(string) --* The ARN of the signal catalog associated with the state template. * **stateTemplateProperties** *(list) --* A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals. * *(string) --* * **dataExtraDimensions** *(list) --* A list of vehicle attributes associated with the payload published on the state template's MQTT topic. Default: An empty array * *(string) --* * **metadataExtraDimensions** *(list) --* A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. Default: An empty array * *(string) --* * **creationTime** *(datetime) --* The time the state template was created in seconds since epoch (January 1, 1970 at midnight UTC time). * **lastModificationTime** *(datetime) --* The time the state template was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). * **id** *(string) --* The unique ID of the state template. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / list_tags_for_resource list_tags_for_resource ********************** IoTFleetWise.Client.list_tags_for_resource(**kwargs) Lists the tags (metadata) you have assigned to the resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceARN='string' ) Parameters: **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the resource. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / untag_resource untag_resource ************** IoTFleetWise.Client.untag_resource(**kwargs) Removes the given tags (metadata) from the resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceARN='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the resource. * **TagKeys** (*list*) -- **[REQUIRED]** A list of the keys of the tags to be removed from the resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / delete_fleet delete_fleet ************ IoTFleetWise.Client.delete_fleet(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.delete_fleet( fleetId='string' ) Parameters: **fleetId** (*string*) -- **[REQUIRED]** The ID of the fleet to delete. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / create_campaign create_campaign *************** IoTFleetWise.Client.create_campaign(**kwargs) 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*. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. See also: AWS API Documentation **Request Syntax** response = 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, 'dataPartitionId': 'string' }, ], collectionScheme={ 'timeBasedCollectionScheme': { 'periodMs': 123 }, 'conditionBasedCollectionScheme': { 'expression': 'string', 'minimumTriggerIntervalMs': 123, 'triggerMode': 'ALWAYS'|'RISING_EDGE', 'conditionLanguageVersion': 123 } }, dataExtraDimensions=[ 'string', ], tags=[ { 'Key': 'string', 'Value': 'string' }, ], dataDestinationConfigs=[ { 's3Config': { 'bucketArn': 'string', 'dataFormat': 'JSON'|'PARQUET', 'storageCompressionFormat': 'NONE'|'GZIP', 'prefix': 'string' }, 'timestreamConfig': { 'timestreamTableArn': 'string', 'executionRoleArn': 'string' }, 'mqttTopicConfig': { 'mqttTopicArn': 'string', 'executionRoleArn': 'string' } }, ], dataPartitions=[ { 'id': 'string', 'storageOptions': { 'maximumSize': { 'unit': 'MB'|'GB'|'TB', 'value': 123 }, 'storageLocation': 'string', 'minimumTimeToLive': { 'unit': 'HOURS'|'DAYS'|'WEEKS', 'value': 123 } }, 'uploadOptions': { 'expression': 'string', 'conditionLanguageVersion': 123 } }, ], signalsToFetch=[ { 'fullyQualifiedName': 'string', 'signalFetchConfig': { 'timeBased': { 'executionFrequencyMs': 123 }, 'conditionBased': { 'conditionExpression': 'string', 'triggerMode': 'ALWAYS'|'RISING_EDGE' } }, 'conditionLanguageVersion': 123, 'actions': [ 'string', ] }, ] ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the campaign to create. * **description** (*string*) -- An optional description of the campaign to help identify its purpose. * **signalCatalogArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign. * **targetArn** (*string*) -- **[REQUIRED]** The ARN of the vehicle or fleet to deploy a campaign to. * **startTime** (*datetime*) -- The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, "0" is used. Default: "0" * **expiryTime** (*datetime*) -- The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires. Default: 253402214400 (December 31, 9999, 00:00:00 UTC) * **postTriggerCollectionDuration** (*integer*) -- 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" * **diagnosticsMode** (*string*) -- 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" * **spoolingMode** (*string*) -- Determines 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" * **compression** (*string*) -- Determines 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" * **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. If it's not specified, "0" is used. Default: "0" * **signalsToCollect** (*list*) -- A list of information about signals to collect. Note: If you upload a signal as a condition in a data partition for a campaign, then those same signals must be included in "signalsToCollect". * *(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. * **dataPartitionId** *(string) --* The ID of the data partition this signal is associated with. The ID must match one of the IDs provided in "dataPartitions". This is accomplished either by specifying a particular data partition ID or by using "default" for an established default partition. You can establish a default partition in the "DataPartition" data type. Note: If you upload a signal as a condition for a campaign's data partition, the same signal must be included in "signalsToCollect". Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **collectionScheme** (*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. * **dataExtraDimensions** (*list*) -- A list of vehicle attributes to associate with a campaign. Enrich the data with specified vehicle attributes. For example, add "make" and "model" to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against "make" and "model". Default: An empty array * *(string) --* * **tags** (*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. * **dataDestinationConfigs** (*list*) -- The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream. MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices. Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at- least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability. You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns. * *(dict) --* The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "s3Config", "timestreamConfig", "mqttTopicConfig". * **s3Config** *(dict) --* The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data. * **bucketArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon S3 bucket. * **dataFormat** *(string) --* Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format. * Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default. * JSON - Store data in a standard text-based JSON file format. * **storageCompressionFormat** *(string) --* By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage. * **prefix** *(string) --* Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the *Amazon Simple Storage Service User Guide*. By default, Amazon Web Services IoT FleetWise sets the prefix "processed- data/year=YY/month=MM/date=DD/hour=HH/" (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix "vehicles", the prefix will be "vehicles/processed- data/year=YY/month=MM/date=DD/hour=HH/". * **timestreamConfig** *(dict) --* The Amazon Timestream table where the campaign sends data. * **timestreamTableArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon Timestream table. * **executionRoleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the task execution role that grants Amazon Web Services IoT FleetWise permission to deliver data to the Amazon Timestream table. * **mqttTopicConfig** *(dict) --* The MQTT topic to which the Amazon Web Services IoT FleetWise campaign routes data. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **mqttTopicArn** *(string) --* **[REQUIRED]** The ARN of the MQTT topic. * **executionRoleArn** *(string) --* **[REQUIRED]** The ARN of the role that grants Amazon Web Services IoT FleetWise permission to access and act on messages sent to the MQTT topic. * **dataPartitions** (*list*) -- The data partitions associated with the signals collected from the vehicle. * *(dict) --* The configuration for signal data storage and upload options. You can only specify these options when the campaign's spooling mode is "TO_DISK". Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **id** *(string) --* **[REQUIRED]** The ID of the data partition. The data partition ID must be unique within a campaign. You can establish a data partition as the default partition for a campaign by using "default" as the ID. * **storageOptions** *(dict) --* **[REQUIRED]** The storage options for a data partition. * **maximumSize** *(dict) --* **[REQUIRED]** The maximum storage size of the data stored in the data partition. Note: Newer data overwrites older data when the partition reaches the maximum size. * **unit** *(string) --* **[REQUIRED]** The data type of the data to store. * **value** *(integer) --* **[REQUIRED]** The maximum amount of time to store data. * **storageLocation** *(string) --* **[REQUIRED]** The folder name for the data partition under the campaign storage folder. * **minimumTimeToLive** *(dict) --* **[REQUIRED]** The amount of time that data in this partition will be kept on disk. * After the designated amount of time passes, the data can be removed, but it's not guaranteed to be removed. * Before the time expires, data in this partition can still be deleted if the partition reaches its configured maximum size. * Newer data will overwrite older data when the partition reaches the maximum size. * **unit** *(string) --* **[REQUIRED]** The time increment type. * **value** *(integer) --* **[REQUIRED]** The minimum amount of time to store the data. * **uploadOptions** *(dict) --* The upload options for the data partition. * **expression** *(string) --* **[REQUIRED]** The logical expression used to recognize what data to collect. For example, "$variable.`Vehicle.OutsideAirTemperature` >= 105.0". * **conditionLanguageVersion** *(integer) --* The version of the condition language. Defaults to the most recent condition language version. * **signalsToFetch** (*list*) -- A list of information about signals to fetch. * *(dict) --* Information about the signal to be fetched. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the signal to be fetched. * **signalFetchConfig** *(dict) --* **[REQUIRED]** The configuration of the signal fetch operation. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "timeBased", "conditionBased". * **timeBased** *(dict) --* The configuration of a time-based signal fetch operation. * **executionFrequencyMs** *(integer) --* **[REQUIRED]** The frequency with which the signal fetch will be executed. * **conditionBased** *(dict) --* The configuration of a condition-based signal fetch operation. * **conditionExpression** *(string) --* **[REQUIRED]** The condition that must be satisfied to trigger a signal fetch. * **triggerMode** *(string) --* **[REQUIRED]** Indicates the mode in which the signal fetch is triggered. * **conditionLanguageVersion** *(integer) --* The version of the condition language used. * **actions** *(list) --* **[REQUIRED]** The actions to be performed by the signal fetch. * *(string) --* Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / update_model_manifest update_model_manifest ********************* IoTFleetWise.Client.update_model_manifest(**kwargs) 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** response = client.update_model_manifest( name='string', description='string', nodesToAdd=[ 'string', ], nodesToRemove=[ 'string', ], status='ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the vehicle model to update. * **description** (*string*) -- A brief description of the vehicle model. * **nodesToAdd** (*list*) -- A list of "fullyQualifiedName" of nodes, which are a general abstraction of signals, to add to the vehicle model. * *(string) --* * **nodesToRemove** (*list*) -- A list of "fullyQualifiedName" of nodes, which are a general abstraction of signals, to remove from the vehicle model. * *(string) --* * **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. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.InvalidSignalsException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / get_waiter get_waiter ********** IoTFleetWise.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" IoTFleetWise / Client / delete_decoder_manifest delete_decoder_manifest *********************** IoTFleetWise.Client.delete_decoder_manifest(**kwargs) Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it. See also: AWS API Documentation **Request Syntax** response = client.delete_decoder_manifest( name='string' ) Parameters: **name** (*string*) -- **[REQUIRED]** The name of the decoder manifest to delete. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / list_fleets_for_vehicle list_fleets_for_vehicle *********************** IoTFleetWise.Client.list_fleets_for_vehicle(**kwargs) 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** response = client.list_fleets_for_vehicle( vehicleName='string', nextToken='string', maxResults=123 ) Parameters: * **vehicleName** (*string*) -- **[REQUIRED]** The ID of the vehicle to retrieve information about. * **nextToken** (*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. * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / list_state_templates list_state_templates ******************** IoTFleetWise.Client.list_state_templates(**kwargs) Lists information about created state templates. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.list_state_templates( nextToken='string', maxResults=123, listResponseScope='METADATA_ONLY' ) Parameters: * **nextToken** (*string*) -- The token to retrieve the next set of results, or "null" if there are no more results. * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. * **listResponseScope** (*string*) -- When you set the "listResponseScope" parameter to "METADATA_ONLY", the list response includes: state template ID, Amazon Resource Name (ARN), creation time, and last modification time. Return type: dict Returns: **Response Syntax** { 'summaries': [ { 'name': 'string', 'arn': 'string', 'signalCatalogArn': 'string', 'description': 'string', 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1), 'id': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **summaries** *(list) --* A list of information about each state template. * *(dict) --* Information about a state template. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **name** *(string) --* The name of the state template. * **arn** *(string) --* The Amazon Resource Name (ARN) of the state template. * **signalCatalogArn** *(string) --* The Amazon Resource Name (ARN) of the signal catalog associated with the state template. * **description** *(string) --* A brief description of the state template. * **creationTime** *(datetime) --* The time the state template was created, in seconds since epoch (January 1, 1970 at midnight UTC time). * **lastModificationTime** *(datetime) --* The time the state template was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time). * **id** *(string) --* The unique ID of the state template. * **nextToken** *(string) --* The token to retrieve the next set of results, or "null" if there are no more results. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / get_decoder_manifest get_decoder_manifest ******************** IoTFleetWise.Client.get_decoder_manifest(**kwargs) Retrieves information about a created decoder manifest. See also: AWS API Documentation **Request Syntax** response = client.get_decoder_manifest( name='string' ) Parameters: **name** (*string*) -- **[REQUIRED]** The name of the decoder manifest to retrieve information about. Return type: dict Returns: **Response Syntax** { 'name': 'string', 'arn': 'string', 'description': 'string', 'modelManifestArn': 'string', 'status': 'ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING', 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1), 'message': 'string' } **Response Structure** * *(dict) --* * **name** *(string) --* The name of the decoder manifest. * **arn** *(string) --* The Amazon Resource Name (ARN) of the decoder manifest. * **description** *(string) --* A brief description of the decoder manifest. * **modelManifestArn** *(string) --* The ARN of a vehicle model (model manifest) associated with the decoder manifest. * **status** *(string) --* The state of the decoder manifest. If the status is "ACTIVE", the decoder manifest can't be edited. If the status is marked "DRAFT", you can edit the decoder manifest. * **creationTime** *(datetime) --* The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time). * **lastModificationTime** *(datetime) --* The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). * **message** *(string) --* The detailed message for the decoder manifest. When a decoder manifest is in an "INVALID" status, the message contains detailed reason and help information. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / get_signal_catalog get_signal_catalog ****************** IoTFleetWise.Client.get_signal_catalog(**kwargs) Retrieves information about a signal catalog. See also: AWS API Documentation **Request Syntax** response = client.get_signal_catalog( name='string' ) Parameters: **name** (*string*) -- **[REQUIRED]** The name of the signal catalog to retrieve information about. Return type: dict Returns: **Response Syntax** { 'name': 'string', 'arn': 'string', 'description': 'string', 'nodeCounts': { 'totalNodes': 123, 'totalBranches': 123, 'totalSensors': 123, 'totalAttributes': 123, 'totalActuators': 123, 'totalStructs': 123, 'totalProperties': 123 }, 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **name** *(string) --* The name of the signal catalog. * **arn** *(string) --* The Amazon Resource Name (ARN) of the signal catalog. * **description** *(string) --* A brief description of the signal catalog. * **nodeCounts** *(dict) --* The total number of network nodes specified in a signal catalog. * **totalNodes** *(integer) --* The total number of nodes in a vehicle network. * **totalBranches** *(integer) --* The total number of nodes in a vehicle network that represent branches. * **totalSensors** *(integer) --* The total number of nodes in a vehicle network that represent sensors. * **totalAttributes** *(integer) --* The total number of nodes in a vehicle network that represent attributes. * **totalActuators** *(integer) --* The total number of nodes in a vehicle network that represent actuators. * **totalStructs** *(integer) --* The total structure for the node. * **totalProperties** *(integer) --* The total properties for the node. * **creationTime** *(datetime) --* The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time). * **lastModificationTime** *(datetime) --* The last time the signal catalog was modified. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / list_fleets list_fleets *********** IoTFleetWise.Client.list_fleets(**kwargs) 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** response = client.list_fleets( nextToken='string', maxResults=123, listResponseScope='METADATA_ONLY' ) Parameters: * **nextToken** (*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. * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. * **listResponseScope** (*string*) -- When you set the "listResponseScope" parameter to "METADATA_ONLY", the list response includes: fleet ID, Amazon Resource Name (ARN), creation time, and last modification time. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / import_decoder_manifest import_decoder_manifest *********************** IoTFleetWise.Client.import_decoder_manifest(**kwargs) Creates a decoder manifest using your existing CAN DBC file from your local device. The CAN signal name must be unique and not repeated across CAN message definitions in a .dbc file. See also: AWS API Documentation **Request Syntax** response = client.import_decoder_manifest( name='string', networkFileDefinitions=[ { 'canDbc': { 'networkInterface': 'string', 'canDbcFiles': [ b'bytes', ], 'signalsMap': { 'string': 'string' } } }, ] ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the decoder manifest to import. * **networkFileDefinitions** (*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. The DBC file can be a maximum size of 200 MB. * *(bytes) --* * **signalsMap** *(dict) --* Pairs every signal specified in your vehicle model with a signal decoder. * *(string) --* * *(string) --* Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.DecoderManifestValidationExcepti on" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.InvalidSignalsException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / delete_signal_catalog delete_signal_catalog ********************* IoTFleetWise.Client.delete_signal_catalog(**kwargs) Deletes a signal catalog. See also: AWS API Documentation **Request Syntax** response = client.delete_signal_catalog( name='string' ) Parameters: **name** (*string*) -- **[REQUIRED]** The name of the signal catalog to delete. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / batch_create_vehicle batch_create_vehicle ******************** IoTFleetWise.Client.batch_create_vehicle(**kwargs) 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** response = client.batch_create_vehicle( vehicles=[ { 'vehicleName': 'string', 'modelManifestArn': 'string', 'decoderManifestArn': 'string', 'attributes': { 'string': 'string' }, 'associationBehavior': 'CreateIotThing'|'ValidateIotThingExists', 'tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'stateTemplates': [ { 'identifier': 'string', 'stateTemplateUpdateStrategy': { 'periodic': { 'stateTemplateUpdateRate': { 'unit': 'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR', 'value': 123 } }, 'onChange': {} } }, ] }, ] ) Parameters: **vehicles** (*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. * **stateTemplates** *(list) --* Associate state templates to track the state of the vehicle. State templates determine which signal updates the vehicle sends to the cloud. * *(dict) --* The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **identifier** *(string) --* **[REQUIRED]** The unique ID of the state template. * **stateTemplateUpdateStrategy** *(dict) --* **[REQUIRED]** The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an "onChange" or "periodic" update strategy. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "periodic", "onChange". * **periodic** *(dict) --* Vehicles associated with the state template will stream telemetry data during a specified time period. * **stateTemplateUpdateRate** *(dict) --* **[REQUIRED]** The length of time between state template updates. * **unit** *(string) --* **[REQUIRED]** A unit of time. * **value** *(integer) --* **[REQUIRED]** A number of time units. * **onChange** *(dict) --* Vehicles associated with the state template will stream telemetry data when there is a change. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / create_signal_catalog create_signal_catalog ********************* IoTFleetWise.Client.create_signal_catalog(**kwargs) Creates a collection of standardized signals that can be reused to create vehicle models. See also: AWS API Documentation **Request Syntax** response = client.create_signal_catalog( name='string', description='string', nodes=[ { 'branch': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'sensor': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'actuator': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'attribute': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'defaultValue': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'struct': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'property': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'dataEncoding': 'BINARY'|'TYPED', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' } }, ], tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the signal catalog to create. * **description** (*string*) -- A brief description of the signal catalog. * **nodes** (*list*) -- A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type. * *(dict) --* A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "branch", "sensor", "actuator", "attribute", "struct", "property". * **branch** *(dict) --* Information about a node specified as a branch. Note: A group of signals that are defined in a hierarchical structure. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the branch. For example, the fully qualified name of a branch might be "Vehicle.Body.Engine". * **description** *(string) --* A brief description of the branch. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **sensor** *(dict) --* An input component that reports the environmental condition of a vehicle. Note: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be "Vehicle.Body.Engine.Battery". * **dataType** *(string) --* **[REQUIRED]** The specified data type of the sensor. * **description** *(string) --* A brief description of a sensor. * **unit** *(string) --* The scientific unit of measurement for data collected by the sensor. * **allowedValues** *(list) --* A list of possible values a sensor can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of the sensor. * **max** *(float) --* The specified possible maximum value of the sensor. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for a sensor if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of a sensor might be "Vehicle.ADAS.CameraStruct". * **actuator** *(dict) --* Information about a node specified as an actuator. Note: An actuator is a digital representation of a vehicle device. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be "Vehicle.Front.Left.Door.Lock". * **dataType** *(string) --* **[REQUIRED]** The specified data type of the actuator. * **description** *(string) --* A brief description of the actuator. * **unit** *(string) --* The scientific unit for the actuator. * **allowedValues** *(list) --* A list of possible values an actuator can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of an actuator. * **max** *(float) --* The specified possible maximum value of an actuator. * **assignedValue** *(string) --* A specified value for the actuator. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the actuator if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of an actuator might be "Vehicle.Door.LockStruct". * **attribute** *(dict) --* Information about a node specified as an attribute. Note: An attribute represents static information about a vehicle. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be "Vehicle.Body.Engine.Type". * **dataType** *(string) --* **[REQUIRED]** The specified data type of the attribute. * **description** *(string) --* A brief description of the attribute. * **unit** *(string) --* The scientific unit for the attribute. * **allowedValues** *(list) --* A list of possible values an attribute can be assigned. * *(string) --* * **min** *(float) --* The specified possible minimum value of the attribute. * **max** *(float) --* The specified possible maximum value of the attribute. * **assignedValue** *(string) --* A specified value for the attribute. * **defaultValue** *(string) --* The default value of the attribute. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **struct** *(dict) --* Represents a complex or higher-order data structure. * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be "ComplexDataTypes.VehicleDataTypes.SVMCamera". * **description** *(string) --* A brief description of the custom structure. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **property** *(dict) --* Represents a member of the complex data structure. The "datatype" of the property can be either primitive or another "struct". * **fullyQualifiedName** *(string) --* **[REQUIRED]** The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be "ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS". * **dataType** *(string) --* **[REQUIRED]** The data type for the custom property. * **dataEncoding** *(string) --* Indicates whether the property is binary data. * **description** *(string) --* A brief description of the custom property. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the custom property if the data type of the custom property is "Struct" or "StructArray". * **tags** (*list*) -- Metadata that can be used to manage the signal catalog. * *(dict) --* A set of key/value pairs that are used to manage the resource. * **Key** *(string) --* **[REQUIRED]** The tag's key. * **Value** *(string) --* **[REQUIRED]** The tag's value. Return type: dict Returns: **Response Syntax** { 'name': 'string', 'arn': 'string' } **Response Structure** * *(dict) --* * **name** *(string) --* The name of the created signal catalog. * **arn** *(string) --* The ARN of the created signal catalog. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.InvalidNodeException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.InvalidSignalsException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / create_fleet create_fleet ************ IoTFleetWise.Client.create_fleet(**kwargs) 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** response = client.create_fleet( fleetId='string', description='string', signalCatalogArn='string', tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **fleetId** (*string*) -- **[REQUIRED]** The unique ID of the fleet to create. * **description** (*string*) -- A brief description of the fleet to create. * **signalCatalogArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of a signal catalog. * **tags** (*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. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / disassociate_vehicle_fleet disassociate_vehicle_fleet ************************** IoTFleetWise.Client.disassociate_vehicle_fleet(**kwargs) Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle. See also: AWS API Documentation **Request Syntax** response = client.disassociate_vehicle_fleet( vehicleName='string', fleetId='string' ) Parameters: * **vehicleName** (*string*) -- **[REQUIRED]** The unique ID of the vehicle to disassociate from the fleet. * **fleetId** (*string*) -- **[REQUIRED]** The unique ID of a fleet. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / get_campaign get_campaign ************ IoTFleetWise.Client.get_campaign(**kwargs) Retrieves information about a campaign. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_campaign( name='string' ) Parameters: **name** (*string*) -- **[REQUIRED]** The name of the campaign to retrieve information about. Return type: dict Returns: **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, 'dataPartitionId': 'string' }, ], 'collectionScheme': { 'timeBasedCollectionScheme': { 'periodMs': 123 }, 'conditionBasedCollectionScheme': { 'expression': 'string', 'minimumTriggerIntervalMs': 123, 'triggerMode': 'ALWAYS'|'RISING_EDGE', 'conditionLanguageVersion': 123 } }, 'dataExtraDimensions': [ 'string', ], 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1), 'dataDestinationConfigs': [ { 's3Config': { 'bucketArn': 'string', 'dataFormat': 'JSON'|'PARQUET', 'storageCompressionFormat': 'NONE'|'GZIP', 'prefix': 'string' }, 'timestreamConfig': { 'timestreamTableArn': 'string', 'executionRoleArn': 'string' }, 'mqttTopicConfig': { 'mqttTopicArn': 'string', 'executionRoleArn': 'string' } }, ], 'dataPartitions': [ { 'id': 'string', 'storageOptions': { 'maximumSize': { 'unit': 'MB'|'GB'|'TB', 'value': 123 }, 'storageLocation': 'string', 'minimumTimeToLive': { 'unit': 'HOURS'|'DAYS'|'WEEKS', 'value': 123 } }, 'uploadOptions': { 'expression': 'string', 'conditionLanguageVersion': 123 } }, ], 'signalsToFetch': [ { 'fullyQualifiedName': 'string', 'signalFetchConfig': { 'timeBased': { 'executionFrequencyMs': 123 }, 'conditionBased': { 'conditionExpression': 'string', 'triggerMode': 'ALWAYS'|'RISING_EDGE' } }, 'conditionLanguageVersion': 123, 'actions': [ 'string', ] }, ] } **Response Structure** * *(dict) --* * **name** *(string) --* The name of the campaign. * **arn** *(string) --* The Amazon Resource Name (ARN) of the campaign. * **description** *(string) --* The description of the campaign. * **signalCatalogArn** *(string) --* The ARN of a signal catalog. * **targetArn** *(string) --* The ARN of the vehicle or the fleet targeted by the campaign. * **status** *(string) --* The state of the campaign. The status can be one of: "CREATING", "WAITING_FOR_APPROVAL", "RUNNING", and "SUSPENDED". * **startTime** *(datetime) --* The time, in milliseconds, to deliver a campaign after it was approved. * **expiryTime** *(datetime) --* The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires. * **postTriggerCollectionDuration** *(integer) --* How long (in seconds) to collect raw data after a triggering event initiates the collection. * **diagnosticsMode** *(string) --* Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. * **spoolingMode** *(string) --* Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re- established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. * **compression** *(string) --* Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If "OFF" is specified, the signals aren't compressed. If it's not specified, "SNAPPY" is used. * **priority** *(integer) --* A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. * **signalsToCollect** *(list) --* Information about a list of signals to collect data on. * *(dict) --* Information about a signal. * **name** *(string) --* The name of the signal. * **maxSampleCount** *(integer) --* The maximum number of samples to collect. * **minimumSamplingIntervalMs** *(integer) --* The minimum duration of time (in milliseconds) between two triggering events to collect data. Note: If a signal changes often, you might want to collect data at a slower rate. * **dataPartitionId** *(string) --* The ID of the data partition this signal is associated with. The ID must match one of the IDs provided in "dataPartitions". This is accomplished either by specifying a particular data partition ID or by using "default" for an established default partition. You can establish a default partition in the "DataPartition" data type. Note: If you upload a signal as a condition for a campaign's data partition, the same signal must be included in "signalsToCollect". Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **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. * **dataDestinationConfigs** *(list) --* The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream. MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices. Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns. * *(dict) --* The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "s3Config", "timestreamConfig", "mqttTopicConfig". 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'} * **s3Config** *(dict) --* The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data. * **bucketArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon S3 bucket. * **dataFormat** *(string) --* Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format. * Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default. * JSON - Store data in a standard text-based JSON file format. * **storageCompressionFormat** *(string) --* By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage. * **prefix** *(string) --* Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the *Amazon Simple Storage Service User Guide*. By default, Amazon Web Services IoT FleetWise sets the prefix "processed- data/year=YY/month=MM/date=DD/hour=HH/" (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix "vehicles", the prefix will be "vehicles/processed- data/year=YY/month=MM/date=DD/hour=HH/". * **timestreamConfig** *(dict) --* The Amazon Timestream table where the campaign sends data. * **timestreamTableArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Timestream table. * **executionRoleArn** *(string) --* The Amazon Resource Name (ARN) of the task execution role that grants Amazon Web Services IoT FleetWise permission to deliver data to the Amazon Timestream table. * **mqttTopicConfig** *(dict) --* The MQTT topic to which the Amazon Web Services IoT FleetWise campaign routes data. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **mqttTopicArn** *(string) --* The ARN of the MQTT topic. * **executionRoleArn** *(string) --* The ARN of the role that grants Amazon Web Services IoT FleetWise permission to access and act on messages sent to the MQTT topic. * **dataPartitions** *(list) --* The data partitions associated with the signals collected from the vehicle. * *(dict) --* The configuration for signal data storage and upload options. You can only specify these options when the campaign's spooling mode is "TO_DISK". Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **id** *(string) --* The ID of the data partition. The data partition ID must be unique within a campaign. You can establish a data partition as the default partition for a campaign by using "default" as the ID. * **storageOptions** *(dict) --* The storage options for a data partition. * **maximumSize** *(dict) --* The maximum storage size of the data stored in the data partition. Note: Newer data overwrites older data when the partition reaches the maximum size. * **unit** *(string) --* The data type of the data to store. * **value** *(integer) --* The maximum amount of time to store data. * **storageLocation** *(string) --* The folder name for the data partition under the campaign storage folder. * **minimumTimeToLive** *(dict) --* The amount of time that data in this partition will be kept on disk. * After the designated amount of time passes, the data can be removed, but it's not guaranteed to be removed. * Before the time expires, data in this partition can still be deleted if the partition reaches its configured maximum size. * Newer data will overwrite older data when the partition reaches the maximum size. * **unit** *(string) --* The time increment type. * **value** *(integer) --* The minimum amount of time to store the data. * **uploadOptions** *(dict) --* The upload options for the data partition. * **expression** *(string) --* The logical expression used to recognize what data to collect. For example, "$variable.`Vehicle.OutsideAirTemperature` >= 105.0". * **conditionLanguageVersion** *(integer) --* The version of the condition language. Defaults to the most recent condition language version. * **signalsToFetch** *(list) --* Information about a list of signals to fetch data from. * *(dict) --* Information about the signal to be fetched. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **fullyQualifiedName** *(string) --* The fully qualified name of the signal to be fetched. * **signalFetchConfig** *(dict) --* The configuration of the signal fetch operation. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "timeBased", "conditionBased". 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'} * **timeBased** *(dict) --* The configuration of a time-based signal fetch operation. * **executionFrequencyMs** *(integer) --* The frequency with which the signal fetch will be executed. * **conditionBased** *(dict) --* The configuration of a condition-based signal fetch operation. * **conditionExpression** *(string) --* The condition that must be satisfied to trigger a signal fetch. * **triggerMode** *(string) --* Indicates the mode in which the signal fetch is triggered. * **conditionLanguageVersion** *(integer) --* The version of the condition language used. * **actions** *(list) --* The actions to be performed by the signal fetch. * *(string) --* **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / import_signal_catalog import_signal_catalog ********************* IoTFleetWise.Client.import_signal_catalog(**kwargs) Creates a signal catalog using your existing VSS formatted content from your local device. See also: AWS API Documentation **Request Syntax** response = client.import_signal_catalog( name='string', description='string', vss={ 'vssJson': 'string' }, tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the signal catalog to import. * **description** (*string*) -- A brief description of the signal catalog. * **vss** (*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. * **tags** (*list*) -- Metadata that can be used to manage the signal catalog. * *(dict) --* A set of key/value pairs that are used to manage the resource. * **Key** *(string) --* **[REQUIRED]** The tag's key. * **Value** *(string) --* **[REQUIRED]** The tag's value. Return type: dict Returns: **Response Syntax** { 'name': 'string', 'arn': 'string' } **Response Structure** * *(dict) --* * **name** *(string) --* The name of the imported signal catalog. * **arn** *(string) --* The Amazon Resource Name (ARN) of the imported signal catalog. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.InvalidSignalsException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / update_vehicle update_vehicle ************** IoTFleetWise.Client.update_vehicle(**kwargs) Updates a vehicle. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.update_vehicle( vehicleName='string', modelManifestArn='string', decoderManifestArn='string', attributes={ 'string': 'string' }, attributeUpdateMode='Overwrite'|'Merge', stateTemplatesToAdd=[ { 'identifier': 'string', 'stateTemplateUpdateStrategy': { 'periodic': { 'stateTemplateUpdateRate': { 'unit': 'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR', 'value': 123 } }, 'onChange': {} } }, ], stateTemplatesToRemove=[ 'string', ], stateTemplatesToUpdate=[ { 'identifier': 'string', 'stateTemplateUpdateStrategy': { 'periodic': { 'stateTemplateUpdateRate': { 'unit': 'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR', 'value': 123 } }, 'onChange': {} } }, ] ) Parameters: * **vehicleName** (*string*) -- **[REQUIRED]** The unique ID of the vehicle to update. * **modelManifestArn** (*string*) -- The ARN of a vehicle model (model manifest) associated with the vehicle. * **decoderManifestArn** (*string*) -- The ARN of the decoder manifest associated with this vehicle. * **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. * **stateTemplatesToAdd** (*list*) -- Associate state templates with the vehicle. * *(dict) --* The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **identifier** *(string) --* **[REQUIRED]** The unique ID of the state template. * **stateTemplateUpdateStrategy** *(dict) --* **[REQUIRED]** The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an "onChange" or "periodic" update strategy. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "periodic", "onChange". * **periodic** *(dict) --* Vehicles associated with the state template will stream telemetry data during a specified time period. * **stateTemplateUpdateRate** *(dict) --* **[REQUIRED]** The length of time between state template updates. * **unit** *(string) --* **[REQUIRED]** A unit of time. * **value** *(integer) --* **[REQUIRED]** A number of time units. * **onChange** *(dict) --* Vehicles associated with the state template will stream telemetry data when there is a change. * **stateTemplatesToRemove** (*list*) -- Remove state templates from the vehicle. * *(string) --* * **stateTemplatesToUpdate** (*list*) -- Change the "stateTemplateUpdateStrategy" of state templates already associated with the vehicle. * *(dict) --* The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **identifier** *(string) --* **[REQUIRED]** The unique ID of the state template. * **stateTemplateUpdateStrategy** *(dict) --* **[REQUIRED]** The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an "onChange" or "periodic" update strategy. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "periodic", "onChange". * **periodic** *(dict) --* Vehicles associated with the state template will stream telemetry data during a specified time period. * **stateTemplateUpdateRate** *(dict) --* **[REQUIRED]** The length of time between state template updates. * **unit** *(string) --* **[REQUIRED]** A unit of time. * **value** *(integer) --* **[REQUIRED]** A number of time units. * **onChange** *(dict) --* Vehicles associated with the state template will stream telemetry data when there is a change. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / list_decoder_manifest_network_interfaces list_decoder_manifest_network_interfaces **************************************** IoTFleetWise.Client.list_decoder_manifest_network_interfaces(**kwargs) 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** response = client.list_decoder_manifest_network_interfaces( name='string', nextToken='string', maxResults=123 ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the decoder manifest to list information about. * **nextToken** (*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. * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. Return type: dict Returns: **Response Syntax** { 'networkInterfaces': [ { 'interfaceId': 'string', 'type': 'CAN_INTERFACE'|'OBD_INTERFACE'|'VEHICLE_MIDDLEWARE'|'CUSTOM_DECODING_INTERFACE', 'canInterface': { 'name': 'string', 'protocolName': 'string', 'protocolVersion': 'string' }, 'obdInterface': { 'name': 'string', 'requestMessageId': 123, 'obdStandard': 'string', 'pidRequestIntervalSeconds': 123, 'dtcRequestIntervalSeconds': 123, 'useExtendedIds': True|False, 'hasTransmissionEcu': True|False }, 'vehicleMiddleware': { 'name': 'string', 'protocolName': 'ROS_2' }, 'customDecodingInterface': { 'name': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **networkInterfaces** *(list) --* A list of information about network interfaces. * *(dict) --* Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node. To return this information about all the network interfaces specified in a decoder manifest, use the API operation. * **interfaceId** *(string) --* The ID of the network interface. * **type** *(string) --* The network protocol for the vehicle. For example, "CAN_SIGNAL" specifies a protocol that defines how data is communicated between electronic control units (ECUs). "OBD_SIGNAL" specifies a protocol that defines how self- diagnostic data is communicated between ECUs. * **canInterface** *(dict) --* Information about a network interface specified by the Controller Area Network (CAN) protocol. * **name** *(string) --* The unique name of the interface. * **protocolName** *(string) --* The name of the communication protocol for the interface. * **protocolVersion** *(string) --* The version of the communication protocol for the interface. * **obdInterface** *(dict) --* Information about a network interface specified by the on-board diagnostic (OBD) II protocol. * **name** *(string) --* The name of the interface. * **requestMessageId** *(integer) --* The ID of the message requesting vehicle data. * **obdStandard** *(string) --* The standard OBD II PID. * **pidRequestIntervalSeconds** *(integer) --* The maximum number message requests per second. * **dtcRequestIntervalSeconds** *(integer) --* The maximum number message requests per diagnostic trouble code per second. * **useExtendedIds** *(boolean) --* Whether to use extended IDs in the message. * **hasTransmissionEcu** *(boolean) --* Whether the vehicle has a transmission control module (TCM). * **vehicleMiddleware** *(dict) --* The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include "ROS2" and "SOME/IP". * **name** *(string) --* The name of the vehicle middleware. * **protocolName** *(string) --* The protocol name of the vehicle middleware. * **customDecodingInterface** *(dict) --* Information about a custom network interface. * **name** *(string) --* The name of the interface. * **nextToken** *(string) --* The token to retrieve the next set of results, or "null" if there are no more results. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / create_state_template create_state_template ********************* IoTFleetWise.Client.create_state_template(**kwargs) Creates a state template. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_state_template( name='string', description='string', signalCatalogArn='string', stateTemplateProperties=[ 'string', ], dataExtraDimensions=[ 'string', ], metadataExtraDimensions=[ 'string', ], tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the state template. * **description** (*string*) -- A brief description of the state template. * **signalCatalogArn** (*string*) -- **[REQUIRED]** The ARN of the signal catalog associated with the state template. * **stateTemplateProperties** (*list*) -- **[REQUIRED]** A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals. * *(string) --* * **dataExtraDimensions** (*list*) -- A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add "Vehicle.Attributes.Make" and "Vehicle.Attributes.Model" attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the "extraDimensions" field. * *(string) --* * **metadataExtraDimensions** (*list*) -- A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add "Vehicle.Attributes.Make" and "Vehicle.Attributes.Model" attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message. Default: An empty array * *(string) --* * **tags** (*list*) -- Metadata that can be used to manage the state template. * *(dict) --* A set of key/value pairs that are used to manage the resource. * **Key** *(string) --* **[REQUIRED]** The tag's key. * **Value** *(string) --* **[REQUIRED]** The tag's value. Return type: dict Returns: **Response Syntax** { 'name': 'string', 'arn': 'string', 'id': 'string' } **Response Structure** * *(dict) --* * **name** *(string) --* The name of the state template. * **arn** *(string) --* The Amazon Resource Name (ARN) of the state template. * **id** *(string) --* The unique ID of the state template. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.InvalidSignalsException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / get_fleet get_fleet ********* IoTFleetWise.Client.get_fleet(**kwargs) Retrieves information about a fleet. See also: AWS API Documentation **Request Syntax** response = client.get_fleet( fleetId='string' ) Parameters: **fleetId** (*string*) -- **[REQUIRED]** The ID of the fleet to retrieve information about. Return type: dict Returns: **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). **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / close close ***** IoTFleetWise.Client.close() Closes underlying endpoint connections. IoTFleetWise / Client / register_account register_account **************** IoTFleetWise.Client.register_account(**kwargs) Warning: This API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream metadata stored. You should then pass the data destination into the CreateCampaign API operation.You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the DeleteCampaign API operation.If you want to delete the Timestream inline policy from the service-linked role, such as to mitigate an overly permissive policy, you must first delete any existing campaigns. Then delete the service-linked role and register your account again to enable CloudWatch metrics. For more information, see DeleteServiceLinkedRole in the *Identity and Access Management API Reference*. 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." 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** response = client.register_account( timestreamResources={ 'timestreamDatabaseName': 'string', 'timestreamTableName': 'string' }, iamResources={ 'roleArn': 'string' } ) Parameters: * **timestreamResources** (*dict*) -- 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. * **iamResources** (*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". Return type: dict Returns: **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). **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / delete_state_template delete_state_template ********************* IoTFleetWise.Client.delete_state_template(**kwargs) Deletes a state template. See also: AWS API Documentation **Request Syntax** response = client.delete_state_template( identifier='string' ) Parameters: **identifier** (*string*) -- **[REQUIRED]** The unique ID of the state template. Return type: dict Returns: **Response Syntax** { 'name': 'string', 'arn': 'string', 'id': 'string' } **Response Structure** * *(dict) --* * **name** *(string) --* The name of the state template. * **arn** *(string) --* The Amazon Resource Name (ARN) of the state template. * **id** *(string) --* The unique ID of the state template. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / get_encryption_configuration get_encryption_configuration **************************** IoTFleetWise.Client.get_encryption_configuration() Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise. See also: AWS API Documentation **Request Syntax** response = client.get_encryption_configuration() Return type: dict Returns: **Response Syntax** { 'kmsKeyId': 'string', 'encryptionStatus': 'PENDING'|'SUCCESS'|'FAILURE', 'encryptionType': 'KMS_BASED_ENCRYPTION'|'FLEETWISE_DEFAULT_ENCRYPTION', 'errorMessage': 'string', 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **kmsKeyId** *(string) --* The ID of the KMS key that is used for encryption. * **encryptionStatus** *(string) --* The encryption status. * **encryptionType** *(string) --* The type of encryption. Set to "KMS_BASED_ENCRYPTION" to use a KMS key that you own and manage. Set to "FLEETWISE_DEFAULT_ENCRYPTION" to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account. * **errorMessage** *(string) --* The error message that describes why encryption settings couldn't be configured, if applicable. * **creationTime** *(datetime) --* The time when encryption was configured in seconds since epoch (January 1, 1970 at midnight UTC time). * **lastModificationTime** *(datetime) --* The time when encryption was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / list_campaigns list_campaigns ************** IoTFleetWise.Client.list_campaigns(**kwargs) 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** response = client.list_campaigns( nextToken='string', maxResults=123, status='string', listResponseScope='METADATA_ONLY' ) Parameters: * **nextToken** (*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. * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. * **status** (*string*) -- An 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". * **listResponseScope** (*string*) -- When you set the "listResponseScope" parameter to "METADATA_ONLY", the list response includes: campaign name, Amazon Resource Name (ARN), creation time, and last modification time. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / list_signal_catalog_nodes list_signal_catalog_nodes ************************* IoTFleetWise.Client.list_signal_catalog_nodes(**kwargs) 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** response = client.list_signal_catalog_nodes( name='string', nextToken='string', maxResults=123, signalNodeType='SENSOR'|'ACTUATOR'|'ATTRIBUTE'|'BRANCH'|'CUSTOM_STRUCT'|'CUSTOM_PROPERTY' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the signal catalog to list information about. * **nextToken** (*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. * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. * **signalNodeType** (*string*) -- The type of node in the signal catalog. Return type: dict Returns: **Response Syntax** { 'nodes': [ { 'branch': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'sensor': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'actuator': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'attribute': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'defaultValue': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'struct': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'property': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'dataEncoding': 'BINARY'|'TYPED', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **nodes** *(list) --* A list of information about nodes. * *(dict) --* A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "branch", "sensor", "actuator", "attribute", "struct", "property". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **branch** *(dict) --* Information about a node specified as a branch. Note: A group of signals that are defined in a hierarchical structure. * **fullyQualifiedName** *(string) --* The fully qualified name of the branch. For example, the fully qualified name of a branch might be "Vehicle.Body.Engine". * **description** *(string) --* A brief description of the branch. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **sensor** *(dict) --* An input component that reports the environmental condition of a vehicle. Note: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors. * **fullyQualifiedName** *(string) --* The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be "Vehicle.Body.Engine.Battery". * **dataType** *(string) --* The specified data type of the sensor. * **description** *(string) --* A brief description of a sensor. * **unit** *(string) --* The scientific unit of measurement for data collected by the sensor. * **allowedValues** *(list) --* A list of possible values a sensor can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of the sensor. * **max** *(float) --* The specified possible maximum value of the sensor. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for a sensor if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of a sensor might be "Vehicle.ADAS.CameraStruct". * **actuator** *(dict) --* Information about a node specified as an actuator. Note: An actuator is a digital representation of a vehicle device. * **fullyQualifiedName** *(string) --* The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be "Vehicle.Front.Left.Door.Lock". * **dataType** *(string) --* The specified data type of the actuator. * **description** *(string) --* A brief description of the actuator. * **unit** *(string) --* The scientific unit for the actuator. * **allowedValues** *(list) --* A list of possible values an actuator can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of an actuator. * **max** *(float) --* The specified possible maximum value of an actuator. * **assignedValue** *(string) --* A specified value for the actuator. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the actuator if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of an actuator might be "Vehicle.Door.LockStruct". * **attribute** *(dict) --* Information about a node specified as an attribute. Note: An attribute represents static information about a vehicle. * **fullyQualifiedName** *(string) --* The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be "Vehicle.Body.Engine.Type". * **dataType** *(string) --* The specified data type of the attribute. * **description** *(string) --* A brief description of the attribute. * **unit** *(string) --* The scientific unit for the attribute. * **allowedValues** *(list) --* A list of possible values an attribute can be assigned. * *(string) --* * **min** *(float) --* The specified possible minimum value of the attribute. * **max** *(float) --* The specified possible maximum value of the attribute. * **assignedValue** *(string) --* A specified value for the attribute. * **defaultValue** *(string) --* The default value of the attribute. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **struct** *(dict) --* Represents a complex or higher-order data structure. * **fullyQualifiedName** *(string) --* The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be "ComplexDataTypes.VehicleDataTypes.SVMCamera". * **description** *(string) --* A brief description of the custom structure. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **property** *(dict) --* Represents a member of the complex data structure. The "datatype" of the property can be either primitive or another "struct". * **fullyQualifiedName** *(string) --* The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be "ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS". * **dataType** *(string) --* The data type for the custom property. * **dataEncoding** *(string) --* Indicates whether the property is binary data. * **description** *(string) --* A brief description of the custom property. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the custom property if the data type of the custom property is "Struct" or "StructArray". * **nextToken** *(string) --* The token to retrieve the next set of results, or "null" if there are no more results. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / put_logging_options put_logging_options ******************* IoTFleetWise.Client.put_logging_options(**kwargs) Creates or updates the logging option. See also: AWS API Documentation **Request Syntax** response = client.put_logging_options( cloudWatchLogDelivery={ 'logType': 'OFF'|'ERROR', 'logGroupName': 'string' } ) Parameters: **cloudWatchLogDelivery** (*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. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / get_logging_options get_logging_options ******************* IoTFleetWise.Client.get_logging_options() Retrieves the logging options. See also: AWS API Documentation **Request Syntax** response = client.get_logging_options() Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / batch_update_vehicle batch_update_vehicle ******************** IoTFleetWise.Client.batch_update_vehicle(**kwargs) 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** response = client.batch_update_vehicle( vehicles=[ { 'vehicleName': 'string', 'modelManifestArn': 'string', 'decoderManifestArn': 'string', 'attributes': { 'string': 'string' }, 'attributeUpdateMode': 'Overwrite'|'Merge', 'stateTemplatesToAdd': [ { 'identifier': 'string', 'stateTemplateUpdateStrategy': { 'periodic': { 'stateTemplateUpdateRate': { 'unit': 'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR', 'value': 123 } }, 'onChange': {} } }, ], 'stateTemplatesToRemove': [ 'string', ], 'stateTemplatesToUpdate': [ { 'identifier': 'string', 'stateTemplateUpdateStrategy': { 'periodic': { 'stateTemplateUpdateRate': { 'unit': 'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR', 'value': 123 } }, 'onChange': {} } }, ] }, ] ) Parameters: **vehicles** (*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. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **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. * **stateTemplatesToAdd** *(list) --* Associate additional state templates to track the state of the vehicle. State templates determine which signal updates the vehicle sends to the cloud. * *(dict) --* The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **identifier** *(string) --* **[REQUIRED]** The unique ID of the state template. * **stateTemplateUpdateStrategy** *(dict) --* **[REQUIRED]** The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an "onChange" or "periodic" update strategy. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "periodic", "onChange". * **periodic** *(dict) --* Vehicles associated with the state template will stream telemetry data during a specified time period. * **stateTemplateUpdateRate** *(dict) --* **[REQUIRED]** The length of time between state template updates. * **unit** *(string) --* **[REQUIRED]** A unit of time. * **value** *(integer) --* **[REQUIRED]** A number of time units. * **onChange** *(dict) --* Vehicles associated with the state template will stream telemetry data when there is a change. * **stateTemplatesToRemove** *(list) --* Remove existing state template associations from the vehicle. * *(string) --* * **stateTemplatesToUpdate** *(list) --* Change the "stateTemplateUpdateStrategy" of state templates already associated with the vehicle. * *(dict) --* The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **identifier** *(string) --* **[REQUIRED]** The unique ID of the state template. * **stateTemplateUpdateStrategy** *(dict) --* **[REQUIRED]** The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an "onChange" or "periodic" update strategy. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "periodic", "onChange". * **periodic** *(dict) --* Vehicles associated with the state template will stream telemetry data during a specified time period. * **stateTemplateUpdateRate** *(dict) --* **[REQUIRED]** The length of time between state template updates. * **unit** *(string) --* **[REQUIRED]** A unit of time. * **value** *(integer) --* **[REQUIRED]** A number of time units. * **onChange** *(dict) --* Vehicles associated with the state template will stream telemetry data when there is a change. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / tag_resource tag_resource ************ IoTFleetWise.Client.tag_resource(**kwargs) 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** response = client.tag_resource( ResourceARN='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the resource. * **Tags** (*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. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / delete_vehicle delete_vehicle ************** IoTFleetWise.Client.delete_vehicle(**kwargs) Deletes a vehicle and removes it from any campaigns. See also: AWS API Documentation **Request Syntax** response = client.delete_vehicle( vehicleName='string' ) Parameters: **vehicleName** (*string*) -- **[REQUIRED]** The ID of the vehicle to delete. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / list_model_manifest_nodes list_model_manifest_nodes ************************* IoTFleetWise.Client.list_model_manifest_nodes(**kwargs) 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** response = client.list_model_manifest_nodes( name='string', nextToken='string', maxResults=123 ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the vehicle model to list information about. * **nextToken** (*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. * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. Return type: dict Returns: **Response Syntax** { 'nodes': [ { 'branch': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'sensor': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'actuator': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' }, 'attribute': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'description': 'string', 'unit': 'string', 'allowedValues': [ 'string', ], 'min': 123.0, 'max': 123.0, 'assignedValue': 'string', 'defaultValue': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'struct': { 'fullyQualifiedName': 'string', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string' }, 'property': { 'fullyQualifiedName': 'string', 'dataType': 'INT8'|'UINT8'|'INT16'|'UINT16'|'INT32'|'UINT32'|'INT64'|'UINT64'|'BOOLEAN'|'FLOAT'|'DOUBLE'|'STRING'|'UNIX_TIMESTAMP'|'INT8_ARRAY'|'UINT8_ARRAY'|'INT16_ARRAY'|'UINT16_ARRAY'|'INT32_ARRAY'|'UINT32_ARRAY'|'INT64_ARRAY'|'UINT64_ARRAY'|'BOOLEAN_ARRAY'|'FLOAT_ARRAY'|'DOUBLE_ARRAY'|'STRING_ARRAY'|'UNIX_TIMESTAMP_ARRAY'|'UNKNOWN'|'STRUCT'|'STRUCT_ARRAY', 'dataEncoding': 'BINARY'|'TYPED', 'description': 'string', 'deprecationMessage': 'string', 'comment': 'string', 'structFullyQualifiedName': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **nodes** *(list) --* A list of information about nodes. * *(dict) --* A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "branch", "sensor", "actuator", "attribute", "struct", "property". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **branch** *(dict) --* Information about a node specified as a branch. Note: A group of signals that are defined in a hierarchical structure. * **fullyQualifiedName** *(string) --* The fully qualified name of the branch. For example, the fully qualified name of a branch might be "Vehicle.Body.Engine". * **description** *(string) --* A brief description of the branch. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **sensor** *(dict) --* An input component that reports the environmental condition of a vehicle. Note: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors. * **fullyQualifiedName** *(string) --* The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be "Vehicle.Body.Engine.Battery". * **dataType** *(string) --* The specified data type of the sensor. * **description** *(string) --* A brief description of a sensor. * **unit** *(string) --* The scientific unit of measurement for data collected by the sensor. * **allowedValues** *(list) --* A list of possible values a sensor can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of the sensor. * **max** *(float) --* The specified possible maximum value of the sensor. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for a sensor if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of a sensor might be "Vehicle.ADAS.CameraStruct". * **actuator** *(dict) --* Information about a node specified as an actuator. Note: An actuator is a digital representation of a vehicle device. * **fullyQualifiedName** *(string) --* The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be "Vehicle.Front.Left.Door.Lock". * **dataType** *(string) --* The specified data type of the actuator. * **description** *(string) --* A brief description of the actuator. * **unit** *(string) --* The scientific unit for the actuator. * **allowedValues** *(list) --* A list of possible values an actuator can take. * *(string) --* * **min** *(float) --* The specified possible minimum value of an actuator. * **max** *(float) --* The specified possible maximum value of an actuator. * **assignedValue** *(string) --* A specified value for the actuator. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the actuator if the data type of the actuator is "Struct" or "StructArray". For example, the struct fully qualified name of an actuator might be "Vehicle.Door.LockStruct". * **attribute** *(dict) --* Information about a node specified as an attribute. Note: An attribute represents static information about a vehicle. * **fullyQualifiedName** *(string) --* The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be "Vehicle.Body.Engine.Type". * **dataType** *(string) --* The specified data type of the attribute. * **description** *(string) --* A brief description of the attribute. * **unit** *(string) --* The scientific unit for the attribute. * **allowedValues** *(list) --* A list of possible values an attribute can be assigned. * *(string) --* * **min** *(float) --* The specified possible minimum value of the attribute. * **max** *(float) --* The specified possible maximum value of the attribute. * **assignedValue** *(string) --* A specified value for the attribute. * **defaultValue** *(string) --* The default value of the attribute. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **struct** *(dict) --* Represents a complex or higher-order data structure. * **fullyQualifiedName** *(string) --* The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be "ComplexDataTypes.VehicleDataTypes.SVMCamera". * **description** *(string) --* A brief description of the custom structure. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **property** *(dict) --* Represents a member of the complex data structure. The "datatype" of the property can be either primitive or another "struct". * **fullyQualifiedName** *(string) --* The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be "ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS". * **dataType** *(string) --* The data type for the custom property. * **dataEncoding** *(string) --* Indicates whether the property is binary data. * **description** *(string) --* A brief description of the custom property. * **deprecationMessage** *(string) --* The deprecation message for the node or the branch that was moved or deleted. * **comment** *(string) --* A comment in addition to the description. * **structFullyQualifiedName** *(string) --* The fully qualified name of the struct node for the custom property if the data type of the custom property is "Struct" or "StructArray". * **nextToken** *(string) --* The token to retrieve the next set of results, or "null" if there are no more results. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / delete_model_manifest delete_model_manifest ********************* IoTFleetWise.Client.delete_model_manifest(**kwargs) Deletes a vehicle model (model manifest). See also: AWS API Documentation **Request Syntax** response = client.delete_model_manifest( name='string' ) Parameters: **name** (*string*) -- **[REQUIRED]** The name of the model manifest to delete. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / list_model_manifests list_model_manifests ******************** IoTFleetWise.Client.list_model_manifests(**kwargs) 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** response = client.list_model_manifests( signalCatalogArn='string', nextToken='string', maxResults=123, listResponseScope='METADATA_ONLY' ) Parameters: * **signalCatalogArn** (*string*) -- The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned. * **nextToken** (*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. * **maxResults** (*integer*) -- The maximum number of items to return, between 1 and 100, inclusive. * **listResponseScope** (*string*) -- When you set the "listResponseScope" parameter to "METADATA_ONLY", the list response includes: model manifest name, Amazon Resource Name (ARN), creation time, and last modification time. Return type: dict Returns: **Response Syntax** { 'summaries': [ { 'name': 'string', 'arn': 'string', 'signalCatalogArn': 'string', 'description': 'string', 'status': 'ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING', 'creationTime': datetime(2015, 1, 1), 'lastModificationTime': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **summaries** *(list) --* A list of information about vehicle models. * *(dict) --* Information about a vehicle model (model manifest). You can use the API operation to return this information about multiple vehicle models. * **name** *(string) --* The name of the vehicle model. * **arn** *(string) --* The Amazon Resource Name (ARN) of the vehicle model. * **signalCatalogArn** *(string) --* The ARN of the signal catalog associated with the vehicle model. * **description** *(string) --* A brief description of the vehicle model. * **status** *(string) --* The state of the vehicle model. If the status is "ACTIVE", the vehicle model can't be edited. If the status is "DRAFT", you can edit the vehicle model. * **creationTime** *(datetime) --* The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time). * **lastModificationTime** *(datetime) --* The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time). * **nextToken** *(string) --* The token to retrieve the next set of results, or "null" if there are no more results. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / create_vehicle create_vehicle ************** IoTFleetWise.Client.create_vehicle(**kwargs) 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** response = client.create_vehicle( vehicleName='string', modelManifestArn='string', decoderManifestArn='string', attributes={ 'string': 'string' }, associationBehavior='CreateIotThing'|'ValidateIotThingExists', tags=[ { 'Key': 'string', 'Value': 'string' }, ], stateTemplates=[ { 'identifier': 'string', 'stateTemplateUpdateStrategy': { 'periodic': { 'stateTemplateUpdateRate': { 'unit': 'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR', 'value': 123 } }, 'onChange': {} } }, ] ) Parameters: * **vehicleName** (*string*) -- **[REQUIRED]** The unique ID of the vehicle to create. * **modelManifestArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name ARN of a vehicle model. * **decoderManifestArn** (*string*) -- **[REQUIRED]** The ARN of a decoder manifest. * **attributes** (*dict*) -- Static information about a vehicle in a key-value pair. For example: ""engineType"" : ""1.3 L R2"" To use attributes with Campaigns or State Templates, you must include them using the request parameters "dataExtraDimensions" and/or "metadataExtraDimensions" (for state templates only) when creating your campaign/state template. * *(string) --* * *(string) --* * **associationBehavior** (*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: * **tags** (*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. * **stateTemplates** (*list*) -- Associate state templates with the vehicle. You can monitor the last known state of the vehicle in near real time. * *(dict) --* The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. * **identifier** *(string) --* **[REQUIRED]** The unique ID of the state template. * **stateTemplateUpdateStrategy** *(dict) --* **[REQUIRED]** The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an "onChange" or "periodic" update strategy. Warning: Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the *Amazon Web Services IoT FleetWise Developer Guide*. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "periodic", "onChange". * **periodic** *(dict) --* Vehicles associated with the state template will stream telemetry data during a specified time period. * **stateTemplateUpdateRate** *(dict) --* **[REQUIRED]** The length of time between state template updates. * **unit** *(string) --* **[REQUIRED]** A unit of time. * **value** *(integer) --* **[REQUIRED]** A number of time units. * **onChange** *(dict) --* Vehicles associated with the state template will stream telemetry data when there is a change. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / update_fleet update_fleet ************ IoTFleetWise.Client.update_fleet(**kwargs) Updates the description of an existing fleet. See also: AWS API Documentation **Request Syntax** response = client.update_fleet( fleetId='string', description='string' ) Parameters: * **fleetId** (*string*) -- **[REQUIRED]** The ID of the fleet to update. * **description** (*string*) -- An updated description of the fleet. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / delete_campaign delete_campaign *************** IoTFleetWise.Client.delete_campaign(**kwargs) 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** response = client.delete_campaign( name='string' ) Parameters: **name** (*string*) -- **[REQUIRED]** The name of the campaign to delete. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / associate_vehicle_fleet associate_vehicle_fleet *********************** IoTFleetWise.Client.associate_vehicle_fleet(**kwargs) Adds, or associates, a vehicle with a fleet. See also: AWS API Documentation **Request Syntax** response = client.associate_vehicle_fleet( vehicleName='string', fleetId='string' ) Parameters: * **vehicleName** (*string*) -- **[REQUIRED]** The unique ID of the vehicle to associate with the fleet. * **fleetId** (*string*) -- **[REQUIRED]** The ID of a fleet. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.AccessDeniedException" IoTFleetWise / Client / create_model_manifest create_model_manifest ********************* IoTFleetWise.Client.create_model_manifest(**kwargs) 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** response = client.create_model_manifest( name='string', description='string', nodes=[ 'string', ], signalCatalogArn='string', tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the vehicle model to create. * **description** (*string*) -- A brief description of the vehicle model. * **nodes** (*list*) -- **[REQUIRED]** A list of nodes, which are a general abstraction of signals. * *(string) --* * **signalCatalogArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of a signal catalog. * **tags** (*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. Return type: dict Returns: **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. **Exceptions** * "IoTFleetWise.Client.exceptions.ResourceNotFoundException" * "IoTFleetWise.Client.exceptions.InternalServerException" * "IoTFleetWise.Client.exceptions.ConflictException" * "IoTFleetWise.Client.exceptions.LimitExceededException" * "IoTFleetWise.Client.exceptions.ThrottlingException" * "IoTFleetWise.Client.exceptions.ValidationException" * "IoTFleetWise.Client.exceptions.InvalidSignalsException" * "IoTFleetWise.Client.exceptions.AccessDeniedException"