Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetStateTemplate

Retrieves information about 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


{
   "identifier": "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.

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

Response Syntax


{
   "arn": "string",
   "creationTime": number,
   "dataExtraDimensions": [ "string" ],
   "description": "string",
   "id": "string",
   "lastModificationTime": number,
   "metadataExtraDimensions": [ "string" ],
   "name": "string",
   "signalCatalogArn": "string",
   "stateTemplateProperties": [ "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

creationTime

The time the state template was created in seconds since epoch (January 1, 1970 at midnight UTC time).

Type: Timestamp

dataExtraDimensions

A list of vehicle attributes associated with the payload published on the state template's MQTT topic.

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_.]+

description

A brief description of the state template.

Type: String

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

Pattern: [^\u0000-\u001F\u007F]+

id

The unique ID of the state template.

Type: String

Length Constraints: Fixed length of 26.

Pattern: [A-Z0-9]+

lastModificationTime

The time the state template was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

Type: Timestamp

metadataExtraDimensions

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

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_.]+

name

The name of the state template.

Type: String

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

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

signalCatalogArn

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

Type: String

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_.]+

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

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