Network.AWS.EC2.GetConsoleScreenshot

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

The returned content is Base64-encoded.

Creating a Request

getConsoleScreenshot

Arguments

:: Text

gcsInstanceId

-> 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
• gcsDryRun
• gcsInstanceId

data GetConsoleScreenshot

Contains the parameters for the request.

See: getConsoleScreenshot smart constructor.

Instances

Eq GetConsoleScreenshot

Methods

(==) :: GetConsoleScreenshot -> GetConsoleScreenshot -> Bool

(/=) :: GetConsoleScreenshot -> GetConsoleScreenshot -> Bool

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

Methods

readsPrec :: Int -> ReadS GetConsoleScreenshot

readList :: ReadS [GetConsoleScreenshot]

readPrec :: ReadPrec GetConsoleScreenshot

readListPrec :: ReadPrec [GetConsoleScreenshot]

Show GetConsoleScreenshot

Methods

showsPrec :: Int -> GetConsoleScreenshot -> ShowS

show :: GetConsoleScreenshot -> String

showList :: [GetConsoleScreenshot] -> ShowS

Generic GetConsoleScreenshot

Associated Types

type Rep GetConsoleScreenshot :: * -> *

Methods

from :: GetConsoleScreenshot -> Rep GetConsoleScreenshot x

to :: Rep GetConsoleScreenshot x -> GetConsoleScreenshot

Hashable GetConsoleScreenshot

Methods

hashWithSalt :: Int -> GetConsoleScreenshot -> Int

hash :: GetConsoleScreenshot -> Int

NFData GetConsoleScreenshot

Methods

rnf :: GetConsoleScreenshot -> ()

AWSRequest GetConsoleScreenshot

Associated Types

type Rs GetConsoleScreenshot :: *

Methods

request :: GetConsoleScreenshot -> Request GetConsoleScreenshot

response :: MonadResource m => Logger -> Service -> Proxy * GetConsoleScreenshot -> ClientResponse -> m (Response GetConsoleScreenshot)

ToPath GetConsoleScreenshot

Methods

toPath :: GetConsoleScreenshot -> ByteString

ToHeaders GetConsoleScreenshot

Methods

toHeaders :: GetConsoleScreenshot -> [Header]

ToQuery GetConsoleScreenshot

Methods

toQuery :: GetConsoleScreenshot -> QueryString

type Rep GetConsoleScreenshot

type Rep GetConsoleScreenshot = D1 (MetaData "GetConsoleScreenshot" "Network.AWS.EC2.GetConsoleScreenshot" "amazonka-ec2-1.4.4-4aYNmHv73MpJXVQjlVKYjQ" 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

type Rs GetConsoleScreenshot = GetConsoleScreenshotResponse

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

Arguments

:: Int

gcsrsResponseStatus

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

• gcsrsInstanceId
• gcsrsImageData
• gcsrsResponseStatus

data GetConsoleScreenshotResponse

Contains the output of the request.

See: getConsoleScreenshotResponse smart constructor.

Instances

Eq GetConsoleScreenshotResponse

Methods

(==) :: GetConsoleScreenshotResponse -> GetConsoleScreenshotResponse -> Bool

(/=) :: GetConsoleScreenshotResponse -> GetConsoleScreenshotResponse -> Bool

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

Methods

readsPrec :: Int -> ReadS GetConsoleScreenshotResponse

readList :: ReadS [GetConsoleScreenshotResponse]

readPrec :: ReadPrec GetConsoleScreenshotResponse

readListPrec :: ReadPrec [GetConsoleScreenshotResponse]

Show GetConsoleScreenshotResponse

Methods

showsPrec :: Int -> GetConsoleScreenshotResponse -> ShowS

show :: GetConsoleScreenshotResponse -> String

showList :: [GetConsoleScreenshotResponse] -> ShowS

Generic GetConsoleScreenshotResponse

Associated Types

type Rep GetConsoleScreenshotResponse :: * -> *

Methods

from :: GetConsoleScreenshotResponse -> Rep GetConsoleScreenshotResponse x

to :: Rep GetConsoleScreenshotResponse x -> GetConsoleScreenshotResponse

NFData GetConsoleScreenshotResponse

Methods

rnf :: GetConsoleScreenshotResponse -> ()

type Rep GetConsoleScreenshotResponse

type Rep GetConsoleScreenshotResponse = D1 (MetaData "GetConsoleScreenshotResponse" "Network.AWS.EC2.GetConsoleScreenshot" "amazonka-ec2-1.4.4-4aYNmHv73MpJXVQjlVKYjQ" 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

gcsrsInstanceId :: Lens' GetConsoleScreenshotResponse (Maybe Text)

The ID of the instance.

gcsrsImageData :: Lens' GetConsoleScreenshotResponse (Maybe Text)

The data that comprises the image.

gcsrsResponseStatus :: Lens' GetConsoleScreenshotResponse Int

The response status code.