GetVirtualMachine

By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

Request Syntax

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

ResourceArn

The Amazon Resource Name (ARN) of the virtual machine.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Pattern: arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+

Required: Yes

Response Syntax

{
 "VirtualMachine": { 
 "HostName": "string",
 "HypervisorId": "string",
 "LastBackupDate": number,
 "Name": "string",
 "Path": "string",
 "ResourceArn": "string",
 "VmwareTags": [ 
 { 
 "VmwareCategory": "string",
 "VmwareTagDescription": "string",
 "VmwareTagName": "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.

VirtualMachine

This object contains the basic attributes of VirtualMachine contained by the output of GetVirtualMachine

Type: VirtualMachineDetails object

Errors

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

InternalServerException

The operation did not succeed because an internal error occurred. Try again later.

ErrorCode: A description of which internal error occured.

HTTP Status Code: 500

ResourceNotFoundException

A resource that is required for the action wasn't found.

ErrorCode: A description of which resource wasn't found.

HTTP Status Code: 400

ThrottlingException

TPS has been limited to protect against intentional or unintentional high request volumes.

ErrorCode: Error: TPS has been limited to protect against intentional or unintentional high request volumes.

HTTP Status Code: 400

ValidationException

The operation did not succeed because a validation error occurred.

ErrorCode: A description of what caused the validation error.

HTTP Status Code: 400