Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListVirtualMachines

Lists your virtual machines.

Request Syntax


{
   "HypervisorArn": "string",
   "MaxResults": number,
   "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.

HypervisorArn

The Amazon Resource Name (ARN) of the hypervisor connected to your 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: No

MaxResults

The maximum number of virtual machines to list.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Type: String

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

Pattern: .+

Required: No

Response Syntax


{
   "NextToken": "string",
   "VirtualMachines": [ 
      { 
         "HostName": "string",
         "HypervisorId": "string",
         "LastBackupDate": number,
         "Name": "string",
         "Path": "string",
         "ResourceArn": "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

Type: String

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

Pattern: .+

VirtualMachines

A list of your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).

Type: Array of VirtualMachine objects

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