ListStateTemplates
Lists information about created state templates.
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
{
"listResponseScope": "string",
"maxResults": number,
"nextToken": "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.
- listResponseScope
-
When you set the
listResponseScopeparameter toMETADATA_ONLY, the list response includes: state template ID, Amazon Resource Name (ARN), creation time, and last modification time.Type: String
Valid Values:
METADATA_ONLYRequired: No
- maxResults
-
The maximum number of items to return, between 1 and 100, inclusive.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
The token to retrieve the next set of results, or
nullif there are no more results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No
Response Syntax
{
"nextToken": "string",
"summaries": [
{
"arn": "string",
"creationTime": number,
"description": "string",
"id": "string",
"lastModificationTime": number,
"name": "string",
"signalCatalogArn": "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.
- nextToken
-
The token to retrieve the next set of results, or
nullif there are no more results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
- summaries
-
A list of information about each state template.
Type: Array of StateTemplateSummary objects
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
- 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:
