IoTFleetWise / Client / list_state_templates

list_state_templates#

IoTFleetWise.Client.list_state_templates(**kwargs)#

Lists information about created state templates.

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.list_state_templates(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – The token to retrieve the next set of results, or null if there are no more results.

  • maxResults (integer) – The maximum number of items to return, between 1 and 100, inclusive.

Return type:

dict

Returns:

Response Syntax

{
    'summaries': [
        {
            'name': 'string',
            'arn': 'string',
            'signalCatalogArn': 'string',
            'description': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1),
            'id': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • summaries (list) –

      A list of information about each state template.

      • (dict) –

        Information about 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.

        • name (string) –

          The name of the state template.

        • arn (string) –

          The Amazon Resource Name (ARN) of the state template.

        • signalCatalogArn (string) –

          The Amazon Resource Name (ARN) of the signal catalog associated with the state template.

        • description (string) –

          A brief description of the state template.

        • creationTime (datetime) –

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

        • lastModificationTime (datetime) –

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

        • id (string) –

          The unique ID of the state template.

    • nextToken (string) –

      The token to retrieve the next set of results, or null if there are no more results.

Exceptions

  • IoTFleetWise.Client.exceptions.InternalServerException

  • IoTFleetWise.Client.exceptions.ThrottlingException

  • IoTFleetWise.Client.exceptions.ValidationException

  • IoTFleetWise.Client.exceptions.AccessDeniedException