IoTFleetWise / Paginator / ListFleets

ListFleets

class IoTFleetWise.Paginator.ListFleets

paginator = client.get_paginator('list_fleets')

paginate(**kwargs)

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

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

{
    'fleetSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'description': 'string',
            'signalCatalogArn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • fleetSummaries (list) –

    A list of information for each fleet.

    • (dict) –

      Information about a fleet.

      You can use the API operation to return this information about multiple fleets.

      • id (string) –

        The unique ID of the fleet.

      • arn (string) –

        The Amazon Resource Name (ARN) of the fleet.

      • description (string) –

        A brief description of the fleet.

      • signalCatalogArn (string) –

        The ARN of the signal catalog associated with the fleet.

      • creationTime (datetime) –

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

      • lastModificationTime (datetime) –

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

  • NextToken (string) –

    A token to resume pagination.