Skip to content

get_serial_console_access_status

Operation

get_serial_console_access_status

get_serial_console_access_status(request: GetSerialConsoleAccessStatusInput | GetSerialConsoleAccessStatusInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSerialConsoleAccessStatusInputDict]) -> 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
request GetSerialConsoleAccessStatusInput | GetSerialConsoleAccessStatusInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetSerialConsoleAccessStatusInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetSerialConsoleAccessStatusOutput

An instance of GetSerialConsoleAccessStatusOutput.

get_serial_console_access_status async

get_serial_console_access_status(request: GetSerialConsoleAccessStatusInput | GetSerialConsoleAccessStatusInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSerialConsoleAccessStatusInputDict]) -> 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
request GetSerialConsoleAccessStatusInput | GetSerialConsoleAccessStatusInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetSerialConsoleAccessStatusInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetSerialConsoleAccessStatusOutput

An instance of GetSerialConsoleAccessStatusOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetSerialConsoleAccessStatusInputDict

Bases: TypedDict

Dictionary form of GetSerialConsoleAccessStatusInput.

Attributes

dry_run 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.

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.