IoTFleetWise / Client / get_vehicle_status

get_vehicle_status#

IoTFleetWise.Client.get_vehicle_status(**kwargs)#

Retrieves information about the status of campaigns, decoder manifests, or state templates associated with a vehicle.

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. This parameter is only supported for resources of type CAMPAIGN.

  • maxResults (integer) – The maximum number of items to return, between 1 and 100, inclusive. This parameter is only supported for resources of type CAMPAIGN.

  • 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 a campaign associated with a vehicle.

        • campaignName (string) –

          The name of a campaign.

        • vehicleName (string) –

          The unique ID of the vehicle.

        • status (string) –

          The status of a campaign, which can be one of the following:

          • CREATED - The campaign has been created successfully but has not been approved.

          • READY - The campaign has been approved but has not been deployed to the vehicle.

          • HEALTHY - The campaign has been deployed to the vehicle.

          • SUSPENDED - The campaign has been suspended and data collection is paused.

          • DELETING - The campaign is being removed from the vehicle.

    • nextToken (string) –

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

Exceptions