EC2 / Client / get_serial_console_access_status

get_serial_console_access_status

EC2.Client.get_serial_console_access_status(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_serial_console_access_status(
    DryRun=True|False
)

Parameters:

DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'SerialConsoleAccessEnabled': True|False,
    'ManagedBy': 'account'|'declarative-policy'
}

Response Structure

• (dict) –

  • SerialConsoleAccessEnabled (boolean) –

    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.

  • ManagedBy (string) –

    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.