---
title: "POST /#X-Amz-Target=IoTAutobahnControlPlane.GetVehicleStatus"
method: POST
path: "/#X-Amz-Target=IoTAutobahnControlPlane.GetVehicleStatus"
---

# POST /#X-Amz-Target=IoTAutobahnControlPlane.GetVehicleStatus

`POST /#X-Amz-Target=IoTAutobahnControlPlane.GetVehicleStatus`

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

## Headers

- `X-Amz-Target` 'IoTAutobahnControlPlane.GetVehicleStatus', required

## Request body

- GetVehicleStatusRequest
  - `nextToken` string — <p>A pagination token for the next set of results.</p> <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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 <code>CAMPAIGN</code>.</p>
  - `maxResults` integer — The maximum number of items to return, between 1 and 100, inclusive. This parameter is only supported for resources of type <code>CAMPAIGN</code>.
  - `vehicleName` string, required — The ID of the vehicle to retrieve information about.

## Response `200`

Success

- GetVehicleStatusResponse
  - `campaigns` VehicleStatus[] — Lists information about the state of the vehicle with deployed campaigns.
    - `campaignName` string — The name of a campaign.
    - `vehicleName` string — The unique ID of the vehicle.
    - `status` 'CREATED' | 'READY' | 'HEALTHY' | 'SUSPENDED' | 'DELETING' | 'READY_FOR_CHECKIN' — <p>The status of a campaign, which can be one of the following:</p> <ul> <li> <p> <code>CREATED</code> - The campaign exists but is not yet approved.</p> </li> <li> <p> <code>READY</code> - The campaign is approved but has not been deployed to the vehicle. Data has not arrived at the vehicle yet.</p> </li> <li> <p> <code>HEALTHY</code> - The campaign is deployed to the vehicle.</p> </li> <li> <p> <code>SUSPENDED</code> - The campaign is suspended and data collection is paused.</p> </li> <li> <p> <code>DELETING</code> - The campaign is being removed from the vehicle.</p> </li> <li> <p> <code>READY_FOR_CHECKIN</code> - The campaign is approved and waiting for vehicle check-in before deployment.</p> </li> </ul>
  - `nextToken` string — The token to retrieve the next set of results, or <code>null</code> if there are no more results.

## Other responses

- `480` — ResourceNotFoundException
- `481` — InternalServerException
- `482` — ThrottlingException
- `483` — ValidationException
- `484` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/iotfleetwise.md) · [All operations](https://skmtc.net/aws/apis/iotfleetwise/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iotfleetwise/versions/0f1f9edeb409/schema)