GetConsoleScreenshot - Amazon Elastic Compute Cloud
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is Base64-encoded.

For more information, see Instance console output in the Amazon EC2 User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.


Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No


The ID of the instance.

Type: String

Required: Yes


When set to true, acts as keystroke input and wakes up an instance that's in standby or "sleep" mode.

Type: Boolean

Required: No

Response Elements

The following elements are returned by the service.


The data that comprises the image.

Type: String


The ID of the instance.

Type: String


The ID of the request.

Type: String


For information about the errors that are common to all actions, see Common client error codes.



This example returns the image data of a successful request.

Sample Request &InstanceId=i-0598c7d356eba48d7 &AUTHPARAMS

Sample Response

<GetConsoleScreenshotResponse xmlns=""> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <imageData>997987/8kgj49ikjhewkwwe0008084EXAMPLE</imageData> <instanceId>i-765950</instanceId> </GetConsoleScreenshotResponse>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: