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

Contents

Description

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

Synopsis

Creating a Request

getConsoleOutput #

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

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

  • gcoDryRun - 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 .
  • gcoInstanceId - The ID of the instance.

data GetConsoleOutput #

Contains the parameters for GetConsoleOutput.

See: getConsoleOutput smart constructor.

Instances

Eq GetConsoleOutput # 
Data GetConsoleOutput # 

Methods

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

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

toConstr :: GetConsoleOutput -> Constr #

dataTypeOf :: GetConsoleOutput -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetConsoleOutput # 
Show GetConsoleOutput # 
Generic GetConsoleOutput # 
Hashable GetConsoleOutput # 
NFData GetConsoleOutput # 

Methods

rnf :: GetConsoleOutput -> () #

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

Request Lenses

gcoDryRun :: Lens' GetConsoleOutput (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 .

gcoInstanceId :: Lens' GetConsoleOutput Text #

The ID of the instance.

Destructuring the Response

getConsoleOutputResponse #

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

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

data GetConsoleOutputResponse #

Contains the output of GetConsoleOutput.

See: getConsoleOutputResponse smart constructor.

Instances

Eq GetConsoleOutputResponse # 
Data GetConsoleOutputResponse # 

Methods

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

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

toConstr :: GetConsoleOutputResponse -> Constr #

dataTypeOf :: GetConsoleOutputResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetConsoleOutputResponse # 
Show GetConsoleOutputResponse # 
Generic GetConsoleOutputResponse # 
NFData GetConsoleOutputResponse # 
type Rep GetConsoleOutputResponse # 
type Rep GetConsoleOutputResponse = D1 (MetaData "GetConsoleOutputResponse" "Network.AWS.EC2.GetConsoleOutput" "amazonka-ec2-1.4.5-C4CR35JggG2GhWFrIiKGhu" False) (C1 (MetaCons "GetConsoleOutputResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gcorsInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gcorsOutput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_gcorsTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) (S1 (MetaSel (Just Symbol "_gcorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

gcorsOutput :: Lens' GetConsoleOutputResponse (Maybe Text) #

The console output, Base64-encoded. If using a command line tool, the tool decodes the output for you.

gcorsTimestamp :: Lens' GetConsoleOutputResponse (Maybe UTCTime) #

The time the output was last updated.

gcorsResponseStatus :: Lens' GetConsoleOutputResponse Int #

  • - | The response status code.