IoTFleetWise / Client / update_vehicle

update_vehicle#

IoTFleetWise.Client.update_vehicle(**kwargs)#

Updates a vehicle.

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

        A unique, service-generated identifier.

      • 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) –

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