Skip to content

EC2  >  Operations  >  get_serial_console_access_status

get_serial_console_access_status

Operation

get_serial_console_access_status async 

get_serial_console_access_status(input: GetSerialConsoleAccessStatusInput, plugins: list[Plugin] | None = None) -> GetSerialConsoleAccessStatusOutput

Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.

Parameters:

Name Type Description Default
input GetSerialConsoleAccessStatusInput

An instance of GetSerialConsoleAccessStatusInput.

 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
GetSerialConsoleAccessStatusOutput

An instance of GetSerialConsoleAccessStatusOutput.

Input

GetSerialConsoleAccessStatusInput dataclass

Bases: _SerdeShape

Dataclass for GetSerialConsoleAccessStatusInput structure.

Attributes

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

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.

Output

GetSerialConsoleAccessStatusOutput dataclass

Bases: _SerdeShape

Dataclass for GetSerialConsoleAccessStatusOutput structure.

Attributes

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

The entity that manages access to the serial console. Possible values include:

  • account - Access is managed by the account.

  • declarative-policy - Access is managed by a declarative policy and can't be modified by the account.

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.

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

If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.