EnableSerialConsoleAccessCommand

Enables access to the EC2 serial console of all instances for your account. 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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, EnableSerialConsoleAccessCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, EnableSerialConsoleAccessCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // EnableSerialConsoleAccessRequest
  DryRun: true || false,
};
const command = new EnableSerialConsoleAccessCommand(input);
const response = await client.send(command);
// { // EnableSerialConsoleAccessResult
//   SerialConsoleAccessEnabled: true || false,
// };

EnableSerialConsoleAccessCommand Input

Parameter
Type
Description
DryRun
boolean | undefined

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.

EnableSerialConsoleAccessCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
SerialConsoleAccessEnabled
boolean | undefined

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.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.