IoTFleetWise / Paginator / ListVehicles

ListVehicles#

class IoTFleetWise.Paginator.ListVehicles#
paginator = client.get_paginator('list_vehicles')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    modelManifestArn='string',
    attributeNames=[
        'string',
    ],
    attributeValues=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • modelManifestArn (string) – The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional parameter to list only the vehicles created from a certain vehicle model.

  • attributeNames (list) –

    The fully qualified names of the attributes. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type.

    • (string) –

  • attributeValues (list) –

    Static information about a vehicle attribute value in string format. For example:

    "1.3 L R2"

    • (string) –

  • 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

{
    'vehicleSummaries': [
        {
            'vehicleName': 'string',
            'arn': 'string',
            'modelManifestArn': 'string',
            'decoderManifestArn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1),
            'attributes': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • vehicleSummaries (list) –

      A list of vehicles and information about them.

      • (dict) –

        Information about a vehicle.

        To return this information about vehicles in your account, you can use the API operation.

        • vehicleName (string) –

          The unique ID of the vehicle.

        • arn (string) –

          The Amazon Resource Name (ARN) of the vehicle.

        • modelManifestArn (string) –

          The ARN of a vehicle model (model manifest) associated with the vehicle.

        • decoderManifestArn (string) –

          The ARN of a decoder manifest associated with the vehicle.

        • creationTime (datetime) –

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

        • lastModificationTime (datetime) –

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

        • attributes (dict) –

          Static information about a vehicle in a key-value pair. For example:

          "engineType" : "1.3 L R2"

          • (string) –

            • (string) –

    • NextToken (string) –

      A token to resume pagination.