UpdateStateTemplate
Updates a state template.
Important
Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide.
Request Syntax
{
"dataExtraDimensions": [ "string" ],
"description": "string",
"identifier": "string",
"metadataExtraDimensions": [ "string" ],
"stateTemplatePropertiesToAdd": [ "string" ],
"stateTemplatePropertiesToRemove": [ "string" ]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- dataExtraDimensions
-
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.MakeandVehicle.Attributes.Modelattributes, AWS IoT FleetWise will enrich the protobuf encoded payload with those attributes in theextraDimensionsfield.Default: An empty array
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 150.
Pattern:
[a-zA-Z0-9_.]+Required: No
- description
-
A brief description of the state template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[^\u0000-\u001F\u007F]+Required: No
- identifier
-
The unique ID of the state template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z\d\-_:]+Required: Yes
- metadataExtraDimensions
-
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.MakeandVehicle.Attributes.Modelattributes, AWS IoT FleetWise will include these attributes as User Properties with the MQTT message.Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 150.
Pattern:
[a-zA-Z0-9_.]+Required: No
- stateTemplatePropertiesToAdd
-
Add signals from which data is collected as part of the state template.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 500 items.
Length Constraints: Minimum length of 1. Maximum length of 150.
Pattern:
[a-zA-Z0-9_.]+Required: No
- stateTemplatePropertiesToRemove
-
Remove signals from which data is collected as part of the state template.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 500 items.
Length Constraints: Minimum length of 1. Maximum length of 150.
Pattern:
[a-zA-Z0-9_.]+Required: No
Response Syntax
{
"arn": "string",
"id": "string",
"name": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- arn
-
The Amazon Resource Name (ARN) of the state template.
Type: String
- id
-
The unique ID of the state template.
Type: String
Length Constraints: Fixed length of 26.
Pattern:
[A-Z0-9]+ - name
-
The name of the state template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z\d\-_:]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient permission to perform this action.
HTTP Status Code: 400
- InternalServerException
-
The request couldn't be completed because the server temporarily failed.
HTTP Status Code: 500
- InvalidSignalsException
-
The request couldn't be completed because it contains signals that aren't valid.
HTTP Status Code: 400
- LimitExceededException
-
A service quota was exceeded.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource wasn't found.
HTTP Status Code: 400
- ThrottlingException
-
The request couldn't be completed due to throttling.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
