| 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 |
Amazonka.IoTFleetWise.ListVehicles
Description
Retrieves a list of summaries of created vehicles.
This API operation uses pagination. Specify the nextToken parameter in
the request to return more results.
This operation returns paginated results.
Synopsis
- data ListVehicles = ListVehicles' {}
- newListVehicles :: ListVehicles
- listVehicles_maxResults :: Lens' ListVehicles (Maybe Natural)
- listVehicles_modelManifestArn :: Lens' ListVehicles (Maybe Text)
- listVehicles_nextToken :: Lens' ListVehicles (Maybe Text)
- data ListVehiclesResponse = ListVehiclesResponse' {}
- newListVehiclesResponse :: Int -> ListVehiclesResponse
- listVehiclesResponse_nextToken :: Lens' ListVehiclesResponse (Maybe Text)
- listVehiclesResponse_vehicleSummaries :: Lens' ListVehiclesResponse (Maybe [VehicleSummary])
- listVehiclesResponse_httpStatus :: Lens' ListVehiclesResponse Int
Creating a Request
data ListVehicles Source #
See: newListVehicles smart constructor.
Constructors
| ListVehicles' | |
Fields
| |
Instances
newListVehicles :: ListVehicles Source #
Create a value of ListVehicles 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:ListVehicles', listVehicles_maxResults - The maximum number of items to return, between 1 and 100, inclusive.
ListVehicles, listVehicles_modelManifestArn - The Amazon Resource Name (ARN) of a vehicle model (model manifest). You
can use this optional parameter to list only the vehicles created from a
certain vehicle model.
ListVehicles, listVehicles_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.
Request Lenses
listVehicles_maxResults :: Lens' ListVehicles (Maybe Natural) Source #
The maximum number of items to return, between 1 and 100, inclusive.
listVehicles_modelManifestArn :: Lens' ListVehicles (Maybe Text) Source #
The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional parameter to list only the vehicles created from a certain vehicle model.
listVehicles_nextToken :: Lens' ListVehicles (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.
Destructuring the Response
data ListVehiclesResponse Source #
See: newListVehiclesResponse smart constructor.
Constructors
| ListVehiclesResponse' | |
Fields
| |
Instances
newListVehiclesResponse Source #
Arguments
| :: Int | |
| -> ListVehiclesResponse |
Create a value of ListVehiclesResponse 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:
ListVehicles, listVehiclesResponse_nextToken - The token to retrieve the next set of results, or null if there are no
more results.
$sel:vehicleSummaries:ListVehiclesResponse', listVehiclesResponse_vehicleSummaries - A list of vehicles and information about them.
$sel:httpStatus:ListVehiclesResponse', listVehiclesResponse_httpStatus - The response's http status code.
Response Lenses
listVehiclesResponse_nextToken :: Lens' ListVehiclesResponse (Maybe Text) Source #
The token to retrieve the next set of results, or null if there are no
more results.
listVehiclesResponse_vehicleSummaries :: Lens' ListVehiclesResponse (Maybe [VehicleSummary]) Source #
A list of vehicles and information about them.
listVehiclesResponse_httpStatus :: Lens' ListVehiclesResponse Int Source #
The response's http status code.