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]

  A unique, service-generated identifier.

• 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