paws.compute (version 0.1.12)

ec2_get_console_output: Gets the console output for the specified instance

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 Elastic Compute Cloud User Guide.

Usage

ec2_get_console_output(InstanceId, DryRun, Latest)

Value

A list with the following syntax:

list(
  InstanceId = "string",
  Output = "string",
  Timestamp = as.POSIXct(
    "2015-01-01"
  )
)

Arguments

InstanceId

[required] 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.

Latest

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

Default: disabled (false)

Request syntax

svc$get_console_output(
  InstanceId = "string",
  DryRun = TRUE|FALSE,
  Latest = TRUE|FALSE
)

Examples

if (FALSE) {
# This example gets the console output for the specified instance.
svc$get_console_output(
  InstanceId = "i-1234567890abcdef0"
)
}