Skip to content

EC2  >  Operations  >  get_console_screenshot

get_console_screenshot

Operation

get_console_screenshot async 

get_console_screenshot(input: GetConsoleScreenshotInput, plugins: list[Plugin] | None = None) -> GetConsoleScreenshotOutput

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:

Name Type Description Default
input GetConsoleScreenshotInput

An instance of GetConsoleScreenshotInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
GetConsoleScreenshotOutput

An instance of GetConsoleScreenshotOutput.

Input

GetConsoleScreenshotInput dataclass

Bases: _SerdeShape

Dataclass for GetConsoleScreenshotInput structure.

Attributes

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

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.

instance_id class-attribute instance-attribute 
instance_id: str | None = ...

The ID of the instance.

wake_up class-attribute instance-attribute 
wake_up: bool | None = ...

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

Output

GetConsoleScreenshotOutput dataclass

Bases: _SerdeShape

Dataclass for GetConsoleScreenshotOutput structure.

Attributes

image_data class-attribute instance-attribute 
image_data: str | None = ...

The data that comprises the image.

instance_id class-attribute instance-attribute 
instance_id: str | None = ...

The ID of the instance.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.