amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.GetConsoleScreenshot

Description

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

The returned content is Base64-encoded.

Synopsis

Creating a Request

data GetConsoleScreenshot Source #

See: newGetConsoleScreenshot smart constructor.

Constructors

GetConsoleScreenshot' 

Fields

  • dryRun :: Maybe Bool

    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.

  • wakeUp :: Maybe Bool

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

  • instanceId :: Text

    The ID of the instance.

Instances

Instances details
ToHeaders GetConsoleScreenshot Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

ToPath GetConsoleScreenshot Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

ToQuery GetConsoleScreenshot Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

AWSRequest GetConsoleScreenshot Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

Associated Types

type AWSResponse GetConsoleScreenshot #

Generic GetConsoleScreenshot Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

Associated Types

type Rep GetConsoleScreenshot :: Type -> Type #

Read GetConsoleScreenshot Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

Show GetConsoleScreenshot Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

NFData GetConsoleScreenshot Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

Methods

rnf :: GetConsoleScreenshot -> () #

Eq GetConsoleScreenshot Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

Hashable GetConsoleScreenshot Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

type AWSResponse GetConsoleScreenshot Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

type Rep GetConsoleScreenshot Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

type Rep GetConsoleScreenshot = D1 ('MetaData "GetConsoleScreenshot" "Amazonka.EC2.GetConsoleScreenshot" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetConsoleScreenshot'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "wakeUp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetConsoleScreenshot Source #

Create a value of GetConsoleScreenshot with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:GetConsoleScreenshot', getConsoleScreenshot_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.

$sel:wakeUp:GetConsoleScreenshot', getConsoleScreenshot_wakeUp - When set to true, acts as keystroke input and wakes up an instance that's in standby or "sleep" mode.

GetConsoleScreenshot, getConsoleScreenshot_instanceId - The ID of the instance.

Request Lenses

getConsoleScreenshot_dryRun :: Lens' GetConsoleScreenshot (Maybe Bool) Source #

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.

getConsoleScreenshot_wakeUp :: Lens' GetConsoleScreenshot (Maybe Bool) Source #

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

Destructuring the Response

data GetConsoleScreenshotResponse Source #

See: newGetConsoleScreenshotResponse smart constructor.

Constructors

GetConsoleScreenshotResponse' 

Fields

Instances

Instances details
Generic GetConsoleScreenshotResponse Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

Associated Types

type Rep GetConsoleScreenshotResponse :: Type -> Type #

Read GetConsoleScreenshotResponse Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

Show GetConsoleScreenshotResponse Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

NFData GetConsoleScreenshotResponse Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

Eq GetConsoleScreenshotResponse Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

type Rep GetConsoleScreenshotResponse Source # 
Instance details

Defined in Amazonka.EC2.GetConsoleScreenshot

type Rep GetConsoleScreenshotResponse = D1 ('MetaData "GetConsoleScreenshotResponse" "Amazonka.EC2.GetConsoleScreenshot" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetConsoleScreenshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetConsoleScreenshotResponse Source #

Create a value of GetConsoleScreenshotResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:imageData:GetConsoleScreenshotResponse', getConsoleScreenshotResponse_imageData - The data that comprises the image.

GetConsoleScreenshot, getConsoleScreenshotResponse_instanceId - The ID of the instance.

$sel:httpStatus:GetConsoleScreenshotResponse', getConsoleScreenshotResponse_httpStatus - The response's http status code.

Response Lenses