/AWS1/CL_IOI=>LISTVEHICLES()
¶
About ListVehicles¶
Retrieves a list of summaries of created vehicles.
This API operation uses pagination. Specify the nextToken
parameter in the request to return more results.
Method Signature¶
IMPORTING¶
Optional arguments:¶
IV_MODELMANIFESTARN
TYPE /AWS1/IOIARN
/AWS1/IOIARN
¶
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.
IT_ATTRIBUTENAMES
TYPE /AWS1/CL_IOIATTRNAMESLIST_W=>TT_ATTRIBUTENAMESLIST
TT_ATTRIBUTENAMESLIST
¶
The fully qualified names of the attributes. You can use this optional parameter to list the vehicles containing all the attributes in the request. For example,
attributeNames
could be "Vehicle.Body.Engine.Type, Vehicle.Color
" and the correspondingattributeValues
could be "1.3 L R2, Blue
" . In this case, the API will filter vehicles with an attribute nameVehicle.Body.Engine.Type
that contains a value of1.3 L R2
AND an attribute nameVehicle.Color
that contains a value of "Blue
". A request must contain unique values for theattributeNames
filter and the matching number ofattributeValues
filters to return the subset of vehicles that match the attributes filter condition.
IT_ATTRIBUTEVALUES
TYPE /AWS1/CL_IOIATTRVALUESLIST_W=>TT_ATTRIBUTEVALUESLIST
TT_ATTRIBUTEVALUESLIST
¶
Static information about a vehicle attribute value in string format. You can use this optional parameter in conjunction with
attributeNames
to list the vehicles containing all theattributeValues
corresponding to theattributeNames
filter. For example,attributeValues
could be "1.3 L R2, Blue
" and the correspondingattributeNames
filter could be "Vehicle.Body.Engine.Type, Vehicle.Color
". In this case, the API will filter vehicles with attribute nameVehicle.Body.Engine.Type
that contains a value of1.3 L R2
AND an attribute nameVehicle.Color
that contains a value of "Blue
". A request must contain unique values for theattributeNames
filter and the matching number ofattributeValues
filter to return the subset of vehicles that match the attributes filter condition.
IV_NEXTTOKEN
TYPE /AWS1/IOINEXTTOKEN
/AWS1/IOINEXTTOKEN
¶
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.
IV_MAXRESULTS
TYPE /AWS1/IOILISTVEHICLESMAXRSLTS
/AWS1/IOILISTVEHICLESMAXRSLTS
¶
The maximum number of items to return, between 1 and 100, inclusive.