console_screenshots

Creates, updates, deletes, gets or lists a console_screenshots resource.

Overview

Name	console_screenshots
Type	Resource
Id	aws.ec2.console_screenshots

Fields

The following fields are returned by SELECT queries:

get_console_screenshot

Name	Datatype	Description
image_data	string	The data that comprises the image.
instance_id	string	The ID of the instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_console_screenshot	select	InstanceId, region	DryRun, WakeUp	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
InstanceId	string	The ID of the instance.
region	string	AWS region (default: us-east-1)
DryRun	boolean	Checks whether you have the required permissions for the operation, 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.
WakeUp	boolean	When set to true, acts as keystroke input and wakes up an instance that's in standby or "sleep" mode.

SELECT examples

get_console_screenshot

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.

SELECT
image_data,
instance_id
FROM aws.ec2.console_screenshots
WHERE InstanceId = '{{ InstanceId }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND WakeUp = '{{ WakeUp }}'
;