Skip to content

EC2  >  Operations  >  get_console_output

get_console_output

Operation

get_console_output async

get_console_output(input: GetConsoleOutputInput, plugins: list[Plugin] | None = None) -> GetConsoleOutputOutput

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.

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

Parameters:

Name Type Description Default
input GetConsoleOutputInput

An instance of GetConsoleOutputInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
GetConsoleOutputOutput

An instance of GetConsoleOutputOutput.

Input

GetConsoleOutputInput dataclass

Bases: _SerdeShape

Dataclass for GetConsoleOutputInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

Checks whether you have the required permissions for the operation, 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.

instance_id class-attribute instance-attribute
instance_id: str | None = ...

The ID of the instance.

latest class-attribute instance-attribute
latest: bool | None = ...

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

Default: disabled (false)

Output

GetConsoleOutputOutput dataclass

Bases: _SerdeShape

Dataclass for GetConsoleOutputOutput structure.

Attributes

instance_id class-attribute instance-attribute
instance_id: str | None = ...

The ID of the instance.

output class-attribute instance-attribute
output: str | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

timestamp class-attribute instance-attribute
timestamp: datetime | None = ...

The time at which the output was last updated.