IoTFleetWise / Paginator / ListStateTemplates

ListStateTemplates#

class IoTFleetWise.Paginator.ListStateTemplates#
paginator = client.get_paginator('list_state_templates')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from IoTFleetWise.Client.list_state_templates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

      A token to resume pagination.