Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.EC2.GetConsoleOutput

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the console output for the specified instance. 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. For Windows instances, the instance console output includes output from the EC2Config service.

GetConsoleOutput returns up to 64 KB of console output shortly after it's generated by the instance.

By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post.

You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is only supported on C5, M5, and i3.metal instances.

Creating a Request

getConsoleOutput #

Arguments

:: Text	`gcoInstanceId`
-> 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:

gcoLatest - When enabled, retrieves the latest console output for the instance. Default: disabled (false )
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 #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Methods (==) :: GetConsoleOutput -> GetConsoleOutput -> Bool # (/=) :: GetConsoleOutput -> GetConsoleOutput -> Bool #
Data GetConsoleOutput #
Instance details Defined in Network.AWS.EC2.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 #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Methods readsPrec :: Int -> ReadS GetConsoleOutput # readList :: ReadS [GetConsoleOutput] # readPrec :: ReadPrec GetConsoleOutput # readListPrec :: ReadPrec [GetConsoleOutput] #
Show GetConsoleOutput #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Methods showsPrec :: Int -> GetConsoleOutput -> ShowS # show :: GetConsoleOutput -> String # showList :: [GetConsoleOutput] -> ShowS #
Generic GetConsoleOutput #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Associated Types type Rep GetConsoleOutput :: Type -> Type # Methods from :: GetConsoleOutput -> Rep GetConsoleOutput x # to :: Rep GetConsoleOutput x -> GetConsoleOutput #
Hashable GetConsoleOutput #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Methods hashWithSalt :: Int -> GetConsoleOutput -> Int # hash :: GetConsoleOutput -> Int #
AWSRequest GetConsoleOutput #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Associated Types type Rs GetConsoleOutput :: Type # Methods request :: GetConsoleOutput -> Request GetConsoleOutput # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetConsoleOutput -> ClientResponse -> m (Response GetConsoleOutput) #
ToHeaders GetConsoleOutput #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Methods toHeaders :: GetConsoleOutput -> [Header] #
ToPath GetConsoleOutput #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Methods toPath :: GetConsoleOutput -> ByteString #
ToQuery GetConsoleOutput #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Methods toQuery :: GetConsoleOutput -> QueryString #
NFData GetConsoleOutput #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Methods rnf :: GetConsoleOutput -> () #
type Rep GetConsoleOutput #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput type Rep GetConsoleOutput = D1 (MetaData "GetConsoleOutput" "Network.AWS.EC2.GetConsoleOutput" "amazonka-ec2-1.6.1-H98Zd65xIYr2z4e5UhW9ck" False) (C1 (MetaCons "GetConsoleOutput'" PrefixI True) (S1 (MetaSel (Just "_gcoLatest") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 (MetaSel (Just "_gcoDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_gcoInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs GetConsoleOutput #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput type Rs GetConsoleOutput = GetConsoleOutputResponse

Request Lenses

gcoLatest :: Lens' GetConsoleOutput (Maybe Bool) #

When enabled, retrieves the latest console output for the instance. Default: disabled (false )

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 #

Arguments

:: Int	`gcorsResponseStatus`
-> 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:

gcorsInstanceId - The ID of the instance.
gcorsOutput - The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you.
gcorsTimestamp - The time at which the output was last updated.
gcorsResponseStatus - -- | The response status code.

data GetConsoleOutputResponse #

Contains the output of GetConsoleOutput.

See: getConsoleOutputResponse smart constructor.

Instances

Eq GetConsoleOutputResponse #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Methods (==) :: GetConsoleOutputResponse -> GetConsoleOutputResponse -> Bool # (/=) :: GetConsoleOutputResponse -> GetConsoleOutputResponse -> Bool #
Data GetConsoleOutputResponse #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput 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 #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Methods readsPrec :: Int -> ReadS GetConsoleOutputResponse # readList :: ReadS [GetConsoleOutputResponse] # readPrec :: ReadPrec GetConsoleOutputResponse # readListPrec :: ReadPrec [GetConsoleOutputResponse] #
Show GetConsoleOutputResponse #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Methods showsPrec :: Int -> GetConsoleOutputResponse -> ShowS # show :: GetConsoleOutputResponse -> String # showList :: [GetConsoleOutputResponse] -> ShowS #
Generic GetConsoleOutputResponse #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Associated Types type Rep GetConsoleOutputResponse :: Type -> Type # Methods from :: GetConsoleOutputResponse -> Rep GetConsoleOutputResponse x # to :: Rep GetConsoleOutputResponse x -> GetConsoleOutputResponse #
NFData GetConsoleOutputResponse #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput Methods rnf :: GetConsoleOutputResponse -> () #
type Rep GetConsoleOutputResponse #
Instance details Defined in Network.AWS.EC2.GetConsoleOutput type Rep GetConsoleOutputResponse = D1 (MetaData "GetConsoleOutputResponse" "Network.AWS.EC2.GetConsoleOutput" "amazonka-ec2-1.6.1-H98Zd65xIYr2z4e5UhW9ck" False) (C1 (MetaCons "GetConsoleOutputResponse'" PrefixI True) ((S1 (MetaSel (Just "_gcorsInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_gcorsOutput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_gcorsTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 (MetaSel (Just "_gcorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gcorsInstanceId :: Lens' GetConsoleOutputResponse (Maybe Text) #

The ID of the instance.

gcorsOutput :: Lens' GetConsoleOutputResponse (Maybe Text) #

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

gcorsTimestamp :: Lens' GetConsoleOutputResponse (Maybe UTCTime) #

The time at which the output was last updated.

gcorsResponseStatus :: Lens' GetConsoleOutputResponse Int #

- | The response status code.