:doc:`EC2 <../../ec2>` / Client / get_console_screenshot

**********************
get_console_screenshot
**********************



.. py:method:: 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 <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/troubleshoot-unreachable-instance.html#instance-console-console-output>`__ in the *Amazon EC2 User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetConsoleScreenshot>`_  


  **Request Syntax**
  ::

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

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

    

  
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The ID of the instance.

    

  
  :type WakeUp: boolean
  :param WakeUp: 

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

    

  
  
  :rtype: 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.

        
  