IoTFleetWise / Paginator / GetVehicleStatus

GetVehicleStatus

class IoTFleetWise.Paginator.GetVehicleStatus

paginator = client.get_paginator('get_vehicle_status')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• vehicleName (string) –

  [REQUIRED]

  The ID of the vehicle to retrieve information about.

• 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

{
    'campaigns': [
        {
            'campaignName': 'string',
            'vehicleName': 'string',
            'status': 'CREATED'|'READY'|'HEALTHY'|'SUSPENDED'|'DELETING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • campaigns (list) –

    Lists information about the state of the vehicle with deployed campaigns.

    • (dict) –

      Information about the state of a vehicle and how it relates to the status of a campaign.

      • campaignName (string) –

        The name of a campaign.

      • vehicleName (string) –

        The unique ID of the vehicle.

      • status (string) –

        The state of a vehicle, which can be one of the following:

        • CREATED - Amazon Web Services IoT FleetWise sucessfully created the vehicle.

        • READY - The vehicle is ready to receive a campaign deployment.

        • HEALTHY - A campaign deployment was delivered to the vehicle.

        • SUSPENDED - A campaign associated with the vehicle was suspended and data collection was paused.

        • DELETING - Amazon Web Services IoT FleetWise is removing a campaign from the vehicle.

  • NextToken (string) –

    A token to resume pagination.