Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListVehicles

Retrieves a list of summaries of created vehicles.

Note

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Request Syntax


{
   "attributeNames": [ "string" ],
   "attributeValues": [ "string" ],
   "maxResults": number,
   "modelManifestArn": "string",
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

attributeNames

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 corresponding attributeValues could be "1.3 L R2, Blue" . In this case, the API will filter vehicles with an attribute name Vehicle.Body.Engine.Type that contains a value of 1.3 L R2 AND an attribute name Vehicle.Color that contains a value of "Blue". A request must contain unique values for the attributeNames filter and the matching number of attributeValues filters to return the subset of vehicles that match the attributes filter condition.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 150.

Pattern: [a-zA-Z0-9_.-]+

Required: No

attributeValues

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 the attributeValues corresponding to the attributeNames filter. For example, attributeValues could be "1.3 L R2, Blue" and the corresponding attributeNames filter could be "Vehicle.Body.Engine.Type, Vehicle.Color". In this case, the API will filter vehicles with attribute name Vehicle.Body.Engine.Type that contains a value of 1.3 L R2 AND an attribute name Vehicle.Color that contains a value of "Blue". A request must contain unique values for the attributeNames filter and the matching number of attributeValues filter to return the subset of vehicles that match the attributes filter condition.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: No

maxResults

The maximum number of items to return, between 1 and 100, inclusive.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

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.

Type: String

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

Response Syntax


{
   "nextToken": "string",
   "vehicleSummaries": [ 
      { 
         "arn": "string",
         "attributes": { 
            "string" : "string" 
         },
         "creationTime": number,
         "decoderManifestArn": "string",
         "lastModificationTime": number,
         "modelManifestArn": "string",
         "vehicleName": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

vehicleSummaries

A list of vehicles and information about them.

Type: Array of VehicleSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permission to perform this action.

HTTP Status Code: 400

InternalServerException

The request couldn't be completed because the server temporarily failed.

HTTP Status Code: 500

ThrottlingException

The request couldn't be completed due to throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400