EC2 / Client / get_console_screenshot

get_console_screenshot#

EC2.Client.get_console_screenshot(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_console_screenshot(
    DryRun=True|False,
    InstanceId='string',
    WakeUp=True|False
)
Parameters:

  • 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.

  • InstanceId (string) –

    [REQUIRED]

    The ID of the instance.

  • WakeUp (boolean) – When set to true, acts as keystroke input and wakes up an instance that’s in standby or “sleep” mode.

Return type:

dict

Returns:

Response Syntax

{
    'ImageData': 'string',
    'InstanceId': 'string'
}

Response Structure

  • (dict) –

    • ImageData (string) –

      The data that comprises the image.

    • InstanceId (string) –

      The ID of the instance.