ec2_get_console_screenshot {aws.ecx} | R Documentation |
Get Console Screenshot
Description
Get Console Screenshot
Usage
ec2_get_console_screenshot(
InstanceId,
DryRun = NULL,
WakeUp = NULL,
simplify = TRUE,
others = list(),
print_on_error = aws_get_print_on_error(),
retry_time = aws_get_retry_time(),
network_timeout = aws_get_network_timeout(),
region = aws_get_region()
)
Arguments
InstanceId |
Character. The ID of the instance. |
DryRun |
Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional] |
WakeUp |
Logical. When set to |
simplify |
Logical. Whether to simplify the result and handle |
others |
Named list. The parameters that are not included in the function parameters and need to be added into the request[optional] |
print_on_error |
Logical. Whether to show an error message when a network error occurs. |
retry_time |
Integer. Number of retries for a REST request when encounter the
network issue. If the request has been sent |
network_timeout |
Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms. |
region |
Character. The region of the AWS service. |
Value
A list object or a character vector
InstanceId
The ID of the instance.
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
.
WakeUp
When set
to true
, acts as keystroke input and wakes up an instance that\'s in
standby or \'sleep\' mode.