send_serial_console_ssh_public_key ¶

def send_serial_console_ssh_public_key(
    self,
    instance_id: "capo_ec2_instance_connect.types.instance_id.InstanceId",
    ssh_public_key: "capo_ec2_instance_connect.types.ssh_public_key.SSHPublicKey",
    *,
    config_overrides: Optional[EC2InstanceConnectClientConfig] = None,
    serial_port: Optional[
        "capo_ec2_instance_connect.types.serial_port.SerialPort"
    ] = None,
) -> "capo_ec2_instance_connect.types.send_serial_console_ssh_public_key_response.SendSerialConsoleSSHPublicKeyResponse":
    """<p>Pushes an SSH public key to the specified EC2 instance. The key remains for 60 seconds, which gives you 60 seconds to establish a serial console connection to the instance using SSH. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-serial-console.html">EC2 Serial Console</a> in the <i>Amazon EC2 User Guide</i>.</p>

    Args:
        instance_id: <p>The ID of the EC2 instance.</p>
        serial_port: <p>The serial port of the EC2 instance. Currently only port 0 is supported.</p> <p>Default: 0</p>
        ssh_public_key: <p>The public key material. To use the public key, you must have the matching private key. For information about the supported key formats and lengths, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#how-to-generate-your-own-key-and-import-it-to-aws">Requirements for key pairs</a> in the <i>Amazon EC2 User Guide</i>.</p>

    Raises:
        capo_ec2_instance_connect.errors.auth_exception.AuthException: <p>Either your AWS credentials are not valid or you do not have access to the EC2 instance.</p>
        capo_ec2_instance_connect.errors.ec2_instance_not_found_exception.EC2InstanceNotFoundException: <p>The specified instance was not found.</p>
        capo_ec2_instance_connect.errors.ec2_instance_state_invalid_exception.EC2InstanceStateInvalidException: <p>Unable to connect because the instance is not in a valid state. Connecting to a stopped or terminated instance is not supported. If the instance is stopped, start your instance, and try to connect again.</p>
        capo_ec2_instance_connect.errors.ec2_instance_type_invalid_exception.EC2InstanceTypeInvalidException: <p>The instance type is not supported for connecting via the serial console. Only Nitro instance types are currently supported.</p>
        capo_ec2_instance_connect.errors.ec2_instance_unavailable_exception.EC2InstanceUnavailableException: <p>The instance is currently unavailable. Wait a few minutes and try again.</p>
        capo_ec2_instance_connect.errors.invalid_args_exception.InvalidArgsException: <p>One of the parameters is not valid.</p>
        capo_ec2_instance_connect.errors.serial_console_access_disabled_exception.SerialConsoleAccessDisabledException: <p>Your account is not authorized to use the EC2 Serial Console. To authorize your account, run the EnableSerialConsoleAccess API. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EnableSerialConsoleAccess.html">EnableSerialConsoleAccess</a> in the <i>Amazon EC2 API Reference</i>.</p>
        capo_ec2_instance_connect.errors.serial_console_session_limit_exceeded_exception.SerialConsoleSessionLimitExceededException: <p>The instance currently has 1 active serial console session. Only 1 session is supported at a time.</p>
        capo_ec2_instance_connect.errors.serial_console_session_unavailable_exception.SerialConsoleSessionUnavailableException: <p>Unable to start a serial console session. Please try again.</p>
        capo_ec2_instance_connect.errors.serial_console_session_unsupported_exception.SerialConsoleSessionUnsupportedException: <p>Your instance's BIOS version is unsupported for serial console connection. Reboot your instance to update its BIOS, and then try again to connect.</p>
        capo_ec2_instance_connect.errors.service_exception.ServiceException: <p>The service encountered an error. Follow the instructions in the error message and try again.</p>
        capo_ec2_instance_connect.errors.throttling_exception.ThrottlingException: <p>The requests were made too frequently and have been throttled. Wait a while and try again. To increase the limit on your request frequency, contact AWS Support.</p>
        capo_ec2_instance_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2_instance_connect.types.send_serial_console_ssh_public_key_request.SendSerialConsoleSSHPublicKeyRequest]",
    ) -> OperationResponse[
        "capo_ec2_instance_connect.types.send_serial_console_ssh_public_key_response.SendSerialConsoleSSHPublicKeyResponse"
    ]:
        import capo_ec2_instance_connect._operations.awsec2_instance_connect_service.send_serial_console_ssh_public_key

        output, http_response = (
            capo_ec2_instance_connect._operations.awsec2_instance_connect_service.send_serial_console_ssh_public_key.send_serial_console_ssh_public_key(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SendSerialConsoleSSHPublicKey")
    )
    input_: capo_ec2_instance_connect.types.send_serial_console_ssh_public_key_request.SendSerialConsoleSSHPublicKeyRequest = {
        "instance_id": instance_id,
        "ssh_public_key": ssh_public_key,
    }
    if serial_port is not None:
        input_["serial_port"] = serial_port

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output