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 |
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
Synopsis
- data GetConsoleScreenshot = GetConsoleScreenshot' {}
- newGetConsoleScreenshot :: Text -> GetConsoleScreenshot
- getConsoleScreenshot_dryRun :: Lens' GetConsoleScreenshot (Maybe Bool)
- getConsoleScreenshot_wakeUp :: Lens' GetConsoleScreenshot (Maybe Bool)
- getConsoleScreenshot_instanceId :: Lens' GetConsoleScreenshot Text
- data GetConsoleScreenshotResponse = GetConsoleScreenshotResponse' {
- imageData :: Maybe Text
- instanceId :: Maybe Text
- httpStatus :: Int
- newGetConsoleScreenshotResponse :: Int -> GetConsoleScreenshotResponse
- getConsoleScreenshotResponse_imageData :: Lens' GetConsoleScreenshotResponse (Maybe Text)
- getConsoleScreenshotResponse_instanceId :: Lens' GetConsoleScreenshotResponse (Maybe Text)
- getConsoleScreenshotResponse_httpStatus :: Lens' GetConsoleScreenshotResponse Int
Creating a Request
data GetConsoleScreenshot Source #
See: newGetConsoleScreenshot
smart constructor.
GetConsoleScreenshot' | |
|
Instances
newGetConsoleScreenshot Source #
Create a value of GetConsoleScreenshot
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:GetConsoleScreenshot'
, getConsoleScreenshot_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:wakeUp:GetConsoleScreenshot'
, getConsoleScreenshot_wakeUp
- When set to true
, acts as keystroke input and wakes up an instance
that's in standby or "sleep" mode.
GetConsoleScreenshot
, getConsoleScreenshot_instanceId
- The ID of the instance.
Request Lenses
getConsoleScreenshot_dryRun :: Lens' GetConsoleScreenshot (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
.
getConsoleScreenshot_wakeUp :: Lens' GetConsoleScreenshot (Maybe Bool) Source #
When set to true
, acts as keystroke input and wakes up an instance
that's in standby or "sleep" mode.
getConsoleScreenshot_instanceId :: Lens' GetConsoleScreenshot Text Source #
The ID of the instance.
Destructuring the Response
data GetConsoleScreenshotResponse Source #
See: newGetConsoleScreenshotResponse
smart constructor.
GetConsoleScreenshotResponse' | |
|
Instances
newGetConsoleScreenshotResponse Source #
Create a value of GetConsoleScreenshotResponse
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:imageData:GetConsoleScreenshotResponse'
, getConsoleScreenshotResponse_imageData
- The data that comprises the image.
GetConsoleScreenshot
, getConsoleScreenshotResponse_instanceId
- The ID of the instance.
$sel:httpStatus:GetConsoleScreenshotResponse'
, getConsoleScreenshotResponse_httpStatus
- The response's http status code.
Response Lenses
getConsoleScreenshotResponse_imageData :: Lens' GetConsoleScreenshotResponse (Maybe Text) Source #
The data that comprises the image.
getConsoleScreenshotResponse_instanceId :: Lens' GetConsoleScreenshotResponse (Maybe Text) Source #
The ID of the instance.
getConsoleScreenshotResponse_httpStatus :: Lens' GetConsoleScreenshotResponse Int Source #
The response's http status code.