GETCONSOLESCREENSHOT()`¶

About GetConsoleScreenshot¶

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.

Method Signature¶

METHODS /AWS1/IF_EC2~GETCONSOLESCREENSHOT
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_INSTANCEID TYPE /AWS1/EC2INSTANCEID OPTIONAL
    !IV_WAKEUP TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2getconsolescreen01
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_instanceid` `TYPE /AWS1/EC2INSTANCEID` `/AWS1/EC2INSTANCEID`¶

The ID of the instance.

Optional arguments:¶

`iv_dryrun` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

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.

`iv_wakeup` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2getconsolescreen01` `/AWS1/CL_EC2GETCONSOLESCREEN01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getconsolescreenshot(
  iv_dryrun = ABAP_TRUE
  iv_instanceid = |string|
  iv_wakeup = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_imagedata( ).
  lv_string = lo_result->get_instanceid( ).
ENDIF.

/AWS1/IF_EC2=>GETCONSOLESCREENSHOT()¶