Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.GetConsoleScreenshot

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 Methods toHeaders :: GetConsoleScreenshot -> [Header] #
ToPath GetConsoleScreenshot Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Methods toPath :: GetConsoleScreenshot -> ByteString #
ToQuery GetConsoleScreenshot Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Methods toQuery :: GetConsoleScreenshot -> QueryString #
AWSRequest GetConsoleScreenshot Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Associated Types type AWSResponse GetConsoleScreenshot # Methods request :: (Service -> Service) -> GetConsoleScreenshot -> Request GetConsoleScreenshot # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetConsoleScreenshot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetConsoleScreenshot))) #
Generic GetConsoleScreenshot Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Associated Types type Rep GetConsoleScreenshot :: Type -> Type # Methods from :: GetConsoleScreenshot -> Rep GetConsoleScreenshot x # to :: Rep GetConsoleScreenshot x -> GetConsoleScreenshot #
Read GetConsoleScreenshot Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Methods readsPrec :: Int -> ReadS GetConsoleScreenshot # readList :: ReadS [GetConsoleScreenshot] # readPrec :: ReadPrec GetConsoleScreenshot # readListPrec :: ReadPrec [GetConsoleScreenshot] #
Show GetConsoleScreenshot Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Methods showsPrec :: Int -> GetConsoleScreenshot -> ShowS # show :: GetConsoleScreenshot -> String # showList :: [GetConsoleScreenshot] -> ShowS #
NFData GetConsoleScreenshot Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Methods rnf :: GetConsoleScreenshot -> () #
Eq GetConsoleScreenshot Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Methods (==) :: GetConsoleScreenshot -> GetConsoleScreenshot -> Bool # (/=) :: GetConsoleScreenshot -> GetConsoleScreenshot -> Bool #
Hashable GetConsoleScreenshot Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Methods hashWithSalt :: Int -> GetConsoleScreenshot -> Int # hash :: GetConsoleScreenshot -> Int #
type AWSResponse GetConsoleScreenshot Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot type AWSResponse GetConsoleScreenshot = GetConsoleScreenshotResponse
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 #

Arguments

:: Text	`GetConsoleScreenshot`
-> GetConsoleScreenshot

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.

getConsoleScreenshot_instanceId :: Lens' GetConsoleScreenshot Text Source #

The ID of the instance.

Destructuring the Response

data GetConsoleScreenshotResponse Source #

See: newGetConsoleScreenshotResponse smart constructor.

Constructors

GetConsoleScreenshotResponse'
Fields imageData :: Maybe Text The data that comprises the image. instanceId :: Maybe Text The ID of the instance. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetConsoleScreenshotResponse Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Associated Types type Rep GetConsoleScreenshotResponse :: Type -> Type # Methods from :: GetConsoleScreenshotResponse -> Rep GetConsoleScreenshotResponse x # to :: Rep GetConsoleScreenshotResponse x -> GetConsoleScreenshotResponse #
Read GetConsoleScreenshotResponse Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Methods readsPrec :: Int -> ReadS GetConsoleScreenshotResponse # readList :: ReadS [GetConsoleScreenshotResponse] # readPrec :: ReadPrec GetConsoleScreenshotResponse # readListPrec :: ReadPrec [GetConsoleScreenshotResponse] #
Show GetConsoleScreenshotResponse Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Methods showsPrec :: Int -> GetConsoleScreenshotResponse -> ShowS # show :: GetConsoleScreenshotResponse -> String # showList :: [GetConsoleScreenshotResponse] -> ShowS #
NFData GetConsoleScreenshotResponse Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Methods rnf :: GetConsoleScreenshotResponse -> () #
Eq GetConsoleScreenshotResponse Source #
Instance details Defined in Amazonka.EC2.GetConsoleScreenshot Methods (==) :: GetConsoleScreenshotResponse -> GetConsoleScreenshotResponse -> Bool # (/=) :: GetConsoleScreenshotResponse -> GetConsoleScreenshotResponse -> Bool #
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 #

Arguments

:: Int	`$sel:httpStatus:GetConsoleScreenshotResponse'`
-> GetConsoleScreenshotResponse

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

getConsoleScreenshotResponse_imageData :: Lens' GetConsoleScreenshotResponse (Maybe Text) Source #

The data that comprises the image.

getConsoleScreenshotResponse_instanceId :: Lens' GetConsoleScreenshotResponse (Maybe Text) Source #

The ID of the instance.

getConsoleScreenshotResponse_httpStatus :: Lens' GetConsoleScreenshotResponse Int Source #

The response's http status code.