IoTFleetWise / Client / get_vehicle_status

get_vehicle_status#

IoTFleetWise.Client.get_vehicle_status(**kwargs)#

Retrieves information about the status of a vehicle with any associated campaigns.

See also: AWS API Documentation

Request Syntax

response = client.get_vehicle_status(
    nextToken='string',
    maxResults=123,
    vehicleName='string'
)
Parameters:

  • nextToken (string) –

    A pagination token for the next set of results.

    If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

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

  • vehicleName (string) –

    [REQUIRED]

    The ID of the vehicle to retrieve information about.

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

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

Exceptions