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.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 the last three system event log errors.

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. Only the most recent 64 KB of console output is available.

You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.

For more information, see Instance console output in the Amazon EC2 User Guide.

Synopsis

data GetConsoleOutput = GetConsoleOutput' {
- dryRun :: Maybe Bool
- latest :: Maybe Bool
- instanceId :: Text
}
newGetConsoleOutput :: Text -> GetConsoleOutput
getConsoleOutput_dryRun :: Lens' GetConsoleOutput (Maybe Bool)
getConsoleOutput_latest :: Lens' GetConsoleOutput (Maybe Bool)
getConsoleOutput_instanceId :: Lens' GetConsoleOutput Text
data GetConsoleOutputResponse = GetConsoleOutputResponse' {
- instanceId :: Maybe Text
- output :: Maybe Text
- timestamp :: Maybe ISO8601
- httpStatus :: Int
}
newGetConsoleOutputResponse :: Int -> GetConsoleOutputResponse
getConsoleOutputResponse_instanceId :: Lens' GetConsoleOutputResponse (Maybe Text)
getConsoleOutputResponse_output :: Lens' GetConsoleOutputResponse (Maybe Text)
getConsoleOutputResponse_timestamp :: Lens' GetConsoleOutputResponse (Maybe UTCTime)
getConsoleOutputResponse_httpStatus :: Lens' GetConsoleOutputResponse Int

Creating a Request

data GetConsoleOutput Source #

See: newGetConsoleOutput smart constructor.

Constructors

GetConsoleOutput'

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.
latest :: Maybe Bool
When enabled, retrieves the latest console output for the instance.
Default: disabled (false)
instanceId :: Text
The ID of the instance.

Instances

Instances details

ToHeaders GetConsoleOutput Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Methods toHeaders :: GetConsoleOutput -> [Header] #
ToPath GetConsoleOutput Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Methods toPath :: GetConsoleOutput -> ByteString #
ToQuery GetConsoleOutput Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Methods toQuery :: GetConsoleOutput -> QueryString #
AWSRequest GetConsoleOutput Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Associated Types type AWSResponse GetConsoleOutput # Methods request :: (Service -> Service) -> GetConsoleOutput -> Request GetConsoleOutput # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetConsoleOutput -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetConsoleOutput))) #
Generic GetConsoleOutput Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Associated Types type Rep GetConsoleOutput :: Type -> Type # Methods from :: GetConsoleOutput -> Rep GetConsoleOutput x # to :: Rep GetConsoleOutput x -> GetConsoleOutput #
Read GetConsoleOutput Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Methods readsPrec :: Int -> ReadS GetConsoleOutput # readList :: ReadS [GetConsoleOutput] # readPrec :: ReadPrec GetConsoleOutput # readListPrec :: ReadPrec [GetConsoleOutput] #
Show GetConsoleOutput Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Methods showsPrec :: Int -> GetConsoleOutput -> ShowS # show :: GetConsoleOutput -> String # showList :: [GetConsoleOutput] -> ShowS #
NFData GetConsoleOutput Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Methods rnf :: GetConsoleOutput -> () #
Eq GetConsoleOutput Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Methods (==) :: GetConsoleOutput -> GetConsoleOutput -> Bool # (/=) :: GetConsoleOutput -> GetConsoleOutput -> Bool #
Hashable GetConsoleOutput Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Methods hashWithSalt :: Int -> GetConsoleOutput -> Int # hash :: GetConsoleOutput -> Int #
type AWSResponse GetConsoleOutput Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput type AWSResponse GetConsoleOutput = GetConsoleOutputResponse
type Rep GetConsoleOutput Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput type Rep GetConsoleOutput = D1 ('MetaData "GetConsoleOutput" "Amazonka.EC2.GetConsoleOutput" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetConsoleOutput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "latest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetConsoleOutput Source #

Arguments

:: Text	`GetConsoleOutput`
-> GetConsoleOutput

Create a value of GetConsoleOutput 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:GetConsoleOutput', getConsoleOutput_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:latest:GetConsoleOutput', getConsoleOutput_latest - When enabled, retrieves the latest console output for the instance.

Default: disabled (false)

GetConsoleOutput, getConsoleOutput_instanceId - The ID of the instance.

Request Lenses

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

getConsoleOutput_latest :: Lens' GetConsoleOutput (Maybe Bool) Source #

When enabled, retrieves the latest console output for the instance.

Default: disabled (false)

getConsoleOutput_instanceId :: Lens' GetConsoleOutput Text Source #

The ID of the instance.

Destructuring the Response

data GetConsoleOutputResponse Source #

See: newGetConsoleOutputResponse smart constructor.

Constructors

GetConsoleOutputResponse'
Fields instanceId :: Maybe Text The ID of the instance. output :: Maybe Text The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you. timestamp :: Maybe ISO8601 The time at which the output was last updated. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetConsoleOutputResponse Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Associated Types type Rep GetConsoleOutputResponse :: Type -> Type # Methods from :: GetConsoleOutputResponse -> Rep GetConsoleOutputResponse x # to :: Rep GetConsoleOutputResponse x -> GetConsoleOutputResponse #
Read GetConsoleOutputResponse Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Methods readsPrec :: Int -> ReadS GetConsoleOutputResponse # readList :: ReadS [GetConsoleOutputResponse] # readPrec :: ReadPrec GetConsoleOutputResponse # readListPrec :: ReadPrec [GetConsoleOutputResponse] #
Show GetConsoleOutputResponse Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Methods showsPrec :: Int -> GetConsoleOutputResponse -> ShowS # show :: GetConsoleOutputResponse -> String # showList :: [GetConsoleOutputResponse] -> ShowS #
NFData GetConsoleOutputResponse Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Methods rnf :: GetConsoleOutputResponse -> () #
Eq GetConsoleOutputResponse Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput Methods (==) :: GetConsoleOutputResponse -> GetConsoleOutputResponse -> Bool # (/=) :: GetConsoleOutputResponse -> GetConsoleOutputResponse -> Bool #
type Rep GetConsoleOutputResponse Source #
Instance details Defined in Amazonka.EC2.GetConsoleOutput type Rep GetConsoleOutputResponse = D1 ('MetaData "GetConsoleOutputResponse" "Amazonka.EC2.GetConsoleOutput" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetConsoleOutputResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetConsoleOutputResponse Source #

Arguments

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

Create a value of GetConsoleOutputResponse 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:

GetConsoleOutput, getConsoleOutputResponse_instanceId - The ID of the instance.

$sel:output:GetConsoleOutputResponse', getConsoleOutputResponse_output - The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you.

GetConsoleOutputResponse, getConsoleOutputResponse_timestamp - The time at which the output was last updated.

$sel:httpStatus:GetConsoleOutputResponse', getConsoleOutputResponse_httpStatus - The response's http status code.

Response Lenses

getConsoleOutputResponse_instanceId :: Lens' GetConsoleOutputResponse (Maybe Text) Source #

The ID of the instance.

getConsoleOutputResponse_output :: Lens' GetConsoleOutputResponse (Maybe Text) Source #

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

getConsoleOutputResponse_timestamp :: Lens' GetConsoleOutputResponse (Maybe UTCTime) Source #

The time at which the output was last updated.

getConsoleOutputResponse_httpStatus :: Lens' GetConsoleOutputResponse Int Source #

The response's http status code.