Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Retrieves information about the status of a vehicle with any associated campaigns.
This operation returns paginated results.
Synopsis
- data GetVehicleStatus = GetVehicleStatus' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- vehicleName :: Text
- newGetVehicleStatus :: Text -> GetVehicleStatus
- getVehicleStatus_maxResults :: Lens' GetVehicleStatus (Maybe Natural)
- getVehicleStatus_nextToken :: Lens' GetVehicleStatus (Maybe Text)
- getVehicleStatus_vehicleName :: Lens' GetVehicleStatus Text
- data GetVehicleStatusResponse = GetVehicleStatusResponse' {
- campaigns :: Maybe [VehicleStatus]
- nextToken :: Maybe Text
- httpStatus :: Int
- newGetVehicleStatusResponse :: Int -> GetVehicleStatusResponse
- getVehicleStatusResponse_campaigns :: Lens' GetVehicleStatusResponse (Maybe [VehicleStatus])
- getVehicleStatusResponse_nextToken :: Lens' GetVehicleStatusResponse (Maybe Text)
- getVehicleStatusResponse_httpStatus :: Lens' GetVehicleStatusResponse Int
Creating a Request
data GetVehicleStatus Source #
See: newGetVehicleStatus
smart constructor.
GetVehicleStatus' | |
|
Instances
Create a value of GetVehicleStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetVehicleStatus'
, getVehicleStatus_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
GetVehicleStatus
, getVehicleStatus_nextToken
- 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.
GetVehicleStatus
, getVehicleStatus_vehicleName
- The ID of the vehicle to retrieve information about.
Request Lenses
getVehicleStatus_maxResults :: Lens' GetVehicleStatus (Maybe Natural) Source #
The maximum number of items to return, between 1 and 100, inclusive.
getVehicleStatus_nextToken :: Lens' GetVehicleStatus (Maybe Text) Source #
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.
getVehicleStatus_vehicleName :: Lens' GetVehicleStatus Text Source #
The ID of the vehicle to retrieve information about.
Destructuring the Response
data GetVehicleStatusResponse Source #
See: newGetVehicleStatusResponse
smart constructor.
GetVehicleStatusResponse' | |
|
Instances
newGetVehicleStatusResponse Source #
Create a value of GetVehicleStatusResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:campaigns:GetVehicleStatusResponse'
, getVehicleStatusResponse_campaigns
- Lists information about the state of the vehicle with deployed
campaigns.
GetVehicleStatus
, getVehicleStatusResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:httpStatus:GetVehicleStatusResponse'
, getVehicleStatusResponse_httpStatus
- The response's http status code.
Response Lenses
getVehicleStatusResponse_campaigns :: Lens' GetVehicleStatusResponse (Maybe [VehicleStatus]) Source #
Lists information about the state of the vehicle with deployed campaigns.
getVehicleStatusResponse_nextToken :: Lens' GetVehicleStatusResponse (Maybe Text) Source #
The token to retrieve the next set of results, or null
if there are no
more results.
getVehicleStatusResponse_httpStatus :: Lens' GetVehicleStatusResponse Int Source #
The response's http status code.