amazonka-ec2-1.4.5: Amazon Elastic Compute Cloud SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EC2.GetConsoleScreenshot

Contents

Description

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

The returned content is Base64-encoded.

Synopsis

Creating a Request

getConsoleScreenshot #

Creates a value of GetConsoleScreenshot with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gcsWakeUp - When set to true , acts as keystroke input and wakes up an instance that's in standby or "sleep" mode.
  • gcsDryRun - 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 .
  • gcsInstanceId - The ID of the instance.

data GetConsoleScreenshot #

Contains the parameters for the request.

See: getConsoleScreenshot smart constructor.

Instances

Eq GetConsoleScreenshot # 
Data GetConsoleScreenshot # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetConsoleScreenshot -> c GetConsoleScreenshot #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetConsoleScreenshot #

toConstr :: GetConsoleScreenshot -> Constr #

dataTypeOf :: GetConsoleScreenshot -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetConsoleScreenshot) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetConsoleScreenshot) #

gmapT :: (forall b. Data b => b -> b) -> GetConsoleScreenshot -> GetConsoleScreenshot #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetConsoleScreenshot -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetConsoleScreenshot -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetConsoleScreenshot -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetConsoleScreenshot -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetConsoleScreenshot -> m GetConsoleScreenshot #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetConsoleScreenshot -> m GetConsoleScreenshot #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetConsoleScreenshot -> m GetConsoleScreenshot #

Read GetConsoleScreenshot # 
Show GetConsoleScreenshot # 
Generic GetConsoleScreenshot # 
Hashable GetConsoleScreenshot # 
NFData GetConsoleScreenshot # 

Methods

rnf :: GetConsoleScreenshot -> () #

AWSRequest GetConsoleScreenshot # 
ToQuery GetConsoleScreenshot # 
ToPath GetConsoleScreenshot # 
ToHeaders GetConsoleScreenshot # 
type Rep GetConsoleScreenshot # 
type Rep GetConsoleScreenshot = D1 (MetaData "GetConsoleScreenshot" "Network.AWS.EC2.GetConsoleScreenshot" "amazonka-ec2-1.4.5-C4CR35JggG2GhWFrIiKGhu" False) (C1 (MetaCons "GetConsoleScreenshot'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gcsWakeUp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_gcsDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_gcsInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs GetConsoleScreenshot # 

Request Lenses

gcsWakeUp :: Lens' GetConsoleScreenshot (Maybe Bool) #

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

gcsDryRun :: Lens' GetConsoleScreenshot (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 .

gcsInstanceId :: Lens' GetConsoleScreenshot Text #

The ID of the instance.

Destructuring the Response

getConsoleScreenshotResponse #

Creates a value of GetConsoleScreenshotResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data GetConsoleScreenshotResponse #

Contains the output of the request.

See: getConsoleScreenshotResponse smart constructor.

Instances

Eq GetConsoleScreenshotResponse # 
Data GetConsoleScreenshotResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetConsoleScreenshotResponse -> c GetConsoleScreenshotResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetConsoleScreenshotResponse #

toConstr :: GetConsoleScreenshotResponse -> Constr #

dataTypeOf :: GetConsoleScreenshotResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetConsoleScreenshotResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetConsoleScreenshotResponse) #

gmapT :: (forall b. Data b => b -> b) -> GetConsoleScreenshotResponse -> GetConsoleScreenshotResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetConsoleScreenshotResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetConsoleScreenshotResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetConsoleScreenshotResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetConsoleScreenshotResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetConsoleScreenshotResponse -> m GetConsoleScreenshotResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetConsoleScreenshotResponse -> m GetConsoleScreenshotResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetConsoleScreenshotResponse -> m GetConsoleScreenshotResponse #

Read GetConsoleScreenshotResponse # 
Show GetConsoleScreenshotResponse # 
Generic GetConsoleScreenshotResponse # 
NFData GetConsoleScreenshotResponse # 
type Rep GetConsoleScreenshotResponse # 
type Rep GetConsoleScreenshotResponse = D1 (MetaData "GetConsoleScreenshotResponse" "Network.AWS.EC2.GetConsoleScreenshot" "amazonka-ec2-1.4.5-C4CR35JggG2GhWFrIiKGhu" False) (C1 (MetaCons "GetConsoleScreenshotResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gcsrsInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gcsrsImageData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gcsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

gcsrsImageData :: Lens' GetConsoleScreenshotResponse (Maybe Text) #

The data that comprises the image.