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 |
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.
- getConsoleOutput :: Text -> GetConsoleOutput
- data GetConsoleOutput
- gcoLatest :: Lens' GetConsoleOutput (Maybe Bool)
- gcoDryRun :: Lens' GetConsoleOutput (Maybe Bool)
- gcoInstanceId :: Lens' GetConsoleOutput Text
- getConsoleOutputResponse :: Int -> GetConsoleOutputResponse
- data GetConsoleOutputResponse
- gcorsInstanceId :: Lens' GetConsoleOutputResponse (Maybe Text)
- gcorsOutput :: Lens' GetConsoleOutputResponse (Maybe Text)
- gcorsTimestamp :: Lens' GetConsoleOutputResponse (Maybe UTCTime)
- gcorsResponseStatus :: Lens' GetConsoleOutputResponse Int
Creating a Request
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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.gcoInstanceId
- The ID of the instance.
data GetConsoleOutput Source #
Contains the parameters for GetConsoleOutput.
See: getConsoleOutput
smart constructor.
Request Lenses
gcoLatest :: Lens' GetConsoleOutput (Maybe Bool) Source #
When enabled, retrieves the latest console output for the instance. Default: disabled (false
)
gcoDryRun :: 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
.
gcoInstanceId :: Lens' GetConsoleOutput Text Source #
The ID of the instance.
Destructuring the Response
getConsoleOutputResponse Source #
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 Source #
Contains the output of GetConsoleOutput.
See: getConsoleOutputResponse
smart constructor.
Response Lenses
gcorsInstanceId :: Lens' GetConsoleOutputResponse (Maybe Text) Source #
The ID of the instance.
gcorsOutput :: 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.
gcorsTimestamp :: Lens' GetConsoleOutputResponse (Maybe UTCTime) Source #
The time at which the output was last updated.
gcorsResponseStatus :: Lens' GetConsoleOutputResponse Int Source #
- - | The response status code.