Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeDeviceEc2Instances

Checks the current state of the Amazon EC2-compatible instances. The output is similar to describeDevice, but the results are sourced from the device cache in the AWS Cloud and include a subset of the available fields.

Request Syntax


POST /managed-device/managedDeviceId/resources/ec2/describe HTTP/1.1
Content-type: application/json

{
   "instanceIds": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

managedDeviceId

The ID of the managed device.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

instanceIds

A list of instance IDs associated with the managed device.

Type: Array of strings

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "instances": [ 
      { 
         "instance": { 
            "amiLaunchIndex": number,
            "blockDeviceMappings": [ 
               { 
                  "deviceName": "string",
                  "ebs": { 
                     "attachTime": number,
                     "deleteOnTermination": boolean,
                     "status": "string",
                     "volumeId": "string"
                  }
               }
            ],
            "cpuOptions": { 
               "coreCount": number,
               "threadsPerCore": number
            },
            "createdAt": number,
            "imageId": "string",
            "instanceId": "string",
            "instanceType": "string",
            "privateIpAddress": "string",
            "publicIpAddress": "string",
            "rootDeviceName": "string",
            "securityGroups": [ 
               { 
                  "groupId": "string",
                  "groupName": "string"
               }
            ],
            "state": { 
               "code": number,
               "name": "string"
            },
            "updatedAt": number
         },
         "lastUpdatedAt": number
      }
   ]
}

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.

instances

A list of structures containing information about each instance.

Type: Array of InstanceSummary objects

Errors

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

AccessDeniedException

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

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400