Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetVehicle

Retrieves information about a vehicle.

Request Syntax


{
   "vehicleName": "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.

vehicleName

The ID of the vehicle to retrieve information about.

Type: String

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

Pattern: [a-zA-Z\d\-_:]+

Required: Yes

Response Syntax


{
   "arn": "string",
   "attributes": { 
      "string" : "string" 
   },
   "creationTime": number,
   "decoderManifestArn": "string",
   "lastModificationTime": number,
   "modelManifestArn": "string",
   "stateTemplates": [ 
      { 
         "identifier": "string",
         "stateTemplateUpdateStrategy": { ... }
      }
   ],
   "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.

arn

The Amazon Resource Name (ARN) of the vehicle to retrieve information about.

Type: String

attributes

Static information about a vehicle in a key-value pair. For example:

"engineType" : "1.3 L R2"

Type: String to string map

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

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

creationTime

The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).

Type: Timestamp

decoderManifestArn

The ARN of a decoder manifest associated with the vehicle.

Type: String

lastModificationTime

The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

Type: Timestamp

modelManifestArn

The ARN of a vehicle model (model manifest) associated with the vehicle.

Type: String

stateTemplates

State templates associated with the vehicle.

Type: Array of StateTemplateAssociation objects

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

vehicleName

The ID of the vehicle.

Type: String

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

Pattern: [a-zA-Z\d\-_:]+

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

ResourceNotFoundException

The resource wasn't found.

HTTP Status Code: 400

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