Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateStateTemplate

Creates a state template. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the AWS IoT FleetWise Edge and the AWS Cloud.

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",
   "metadataExtraDimensions": [ "string" ],
   "name": "string",
   "signalCatalogArn": "string",
   "stateTemplateProperties": [ "string" ],
   "tags": [ 
      { 
         "Key": "string",
         "Value": "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.Make and Vehicle.Attributes.Model attributes, AWS IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions field.

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

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.Make and Vehicle.Attributes.Model attributes, AWS IoT FleetWise will include these attributes as User Properties with the MQTT message.

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

name

The name of the state template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z\d\-_:]+

Required: Yes

signalCatalogArn

The ARN of the signal catalog associated with the state template.

Type: String

Required: Yes

stateTemplateProperties

A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.

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: Yes

tags

Metadata that can be used to manage the state template.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

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

ConflictException

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

resource: The resource on which there are conflicting operations.
resourceType: The type of resource on which there are conflicting operations..

HTTP Status Code: 400

InternalServerException

The request couldn't be completed because the server temporarily failed.

retryAfterSeconds: The number of seconds to wait before retrying the command.

HTTP Status Code: 500

InvalidSignalsException

The request couldn't be completed because it contains signals that aren't valid.

invalidSignals: The signals which caused the exception.

HTTP Status Code: 400

LimitExceededException

A service quota was exceeded.

resourceId: The identifier of the resource that was exceeded.
resourceType: The type of resource that was exceeded.

HTTP Status Code: 400

ResourceNotFoundException

The resource wasn't found.

resourceId: The identifier of the resource that wasn't found.
resourceType: The type of resource that wasn't found.

HTTP Status Code: 400

ThrottlingException

The request couldn't be completed due to throttling.

quotaCode: The quota identifier of the applied throttling rules for this request.
retryAfterSeconds: The number of seconds to wait before retrying the command.
serviceCode: The code for the service that couldn't be completed due to throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList: The list of fields that fail to satisfy the constraints specified by an AWS service.
reason: The reason the input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400