Get Console Screenshot

ec2_get_console_screenshot

R Documentation

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

Description

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.

Usage

ec2_get_console_screenshot(DryRun, InstanceId, WakeUp)

Arguments

DryRun

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.

InstanceId

[required] The ID of the instance.

WakeUp

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

Value

A list with the following syntax:

list(
  ImageData = "string",
  InstanceId = "string"
)

Request syntax

svc$get_console_screenshot(
  DryRun = TRUE|FALSE,
  InstanceId = "string",
  WakeUp = TRUE|FALSE
)